Adding kubernetes service
diff --git a/cloudstack/KubernetesService.go b/cloudstack/KubernetesService.go
new file mode 100644
index 0000000..af5a801
--- /dev/null
+++ b/cloudstack/KubernetesService.go
@@ -0,0 +1,2170 @@
+//
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+//
+
+package cloudstack
+
+import (
+ "encoding/json"
+ "fmt"
+ "net/url"
+ "strconv"
+ "strings"
+)
+
+type KubernetesServiceIface interface {
+ AddKubernetesSupportedVersion(p *AddKubernetesSupportedVersionParams) (*AddKubernetesSupportedVersionResponse, error)
+ NewAddKubernetesSupportedVersionParams(mincpunumber int, minmemory int, semanticversion string) *AddKubernetesSupportedVersionParams
+ CreateKubernetesCluster(p *CreateKubernetesClusterParams) (*CreateKubernetesClusterResponse, error)
+ NewCreateKubernetesClusterParams(description string, kubernetesversionid string, name string, serviceofferingid string, size int64, zoneid string) *CreateKubernetesClusterParams
+ DeleteKubernetesCluster(p *DeleteKubernetesClusterParams) (*DeleteKubernetesClusterResponse, error)
+ NewDeleteKubernetesClusterParams(id string) *DeleteKubernetesClusterParams
+ DeleteKubernetesSupportedVersion(p *DeleteKubernetesSupportedVersionParams) (*DeleteKubernetesSupportedVersionResponse, error)
+ NewDeleteKubernetesSupportedVersionParams(id string) *DeleteKubernetesSupportedVersionParams
+ GetKubernetesClusterConfig(p *GetKubernetesClusterConfigParams) (*GetKubernetesClusterConfigResponse, error)
+ NewGetKubernetesClusterConfigParams() *GetKubernetesClusterConfigParams
+ ListKubernetesClusters(p *ListKubernetesClustersParams) (*ListKubernetesClustersResponse, error)
+ NewListKubernetesClustersParams() *ListKubernetesClustersParams
+ GetKubernetesClusterID(name string, opts ...OptionFunc) (string, int, error)
+ GetKubernetesClusterByName(name string, opts ...OptionFunc) (*KubernetesCluster, int, error)
+ GetKubernetesClusterByID(id string, opts ...OptionFunc) (*KubernetesCluster, int, error)
+ ListKubernetesSupportedVersions(p *ListKubernetesSupportedVersionsParams) (*ListKubernetesSupportedVersionsResponse, error)
+ NewListKubernetesSupportedVersionsParams() *ListKubernetesSupportedVersionsParams
+ GetKubernetesSupportedVersionID(keyword string, opts ...OptionFunc) (string, int, error)
+ GetKubernetesSupportedVersionByName(name string, opts ...OptionFunc) (*KubernetesSupportedVersion, int, error)
+ GetKubernetesSupportedVersionByID(id string, opts ...OptionFunc) (*KubernetesSupportedVersion, int, error)
+ ScaleKubernetesCluster(p *ScaleKubernetesClusterParams) (*ScaleKubernetesClusterResponse, error)
+ NewScaleKubernetesClusterParams(id string) *ScaleKubernetesClusterParams
+ StartKubernetesCluster(p *StartKubernetesClusterParams) (*StartKubernetesClusterResponse, error)
+ NewStartKubernetesClusterParams(id string) *StartKubernetesClusterParams
+ StopKubernetesCluster(p *StopKubernetesClusterParams) (*StopKubernetesClusterResponse, error)
+ NewStopKubernetesClusterParams(id string) *StopKubernetesClusterParams
+ UpdateKubernetesSupportedVersion(p *UpdateKubernetesSupportedVersionParams) (*UpdateKubernetesSupportedVersionResponse, error)
+ NewUpdateKubernetesSupportedVersionParams(id string, state string) *UpdateKubernetesSupportedVersionParams
+ UpgradeKubernetesCluster(p *UpgradeKubernetesClusterParams) (*UpgradeKubernetesClusterResponse, error)
+ NewUpgradeKubernetesClusterParams(id string, kubernetesversionid string) *UpgradeKubernetesClusterParams
+}
+
+type AddKubernetesSupportedVersionParams struct {
+ p map[string]interface{}
+}
+
+func (p *AddKubernetesSupportedVersionParams) toURLValues() url.Values {
+ u := url.Values{}
+ if p.p == nil {
+ return u
+ }
+ if v, found := p.p["checksum"]; found {
+ u.Set("checksum", v.(string))
+ }
+ if v, found := p.p["mincpunumber"]; found {
+ vv := strconv.Itoa(v.(int))
+ u.Set("mincpunumber", vv)
+ }
+ if v, found := p.p["minmemory"]; found {
+ vv := strconv.Itoa(v.(int))
+ u.Set("minmemory", vv)
+ }
+ if v, found := p.p["name"]; found {
+ u.Set("name", v.(string))
+ }
+ if v, found := p.p["semanticversion"]; found {
+ u.Set("semanticversion", v.(string))
+ }
+ if v, found := p.p["url"]; found {
+ u.Set("url", v.(string))
+ }
+ if v, found := p.p["zoneid"]; found {
+ u.Set("zoneid", v.(string))
+ }
+ return u
+}
+
+func (p *AddKubernetesSupportedVersionParams) SetChecksum(v string) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["checksum"] = v
+}
+
+func (p *AddKubernetesSupportedVersionParams) GetChecksum() (string, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["checksum"].(string)
+ return value, ok
+}
+
+func (p *AddKubernetesSupportedVersionParams) SetMincpunumber(v int) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["mincpunumber"] = v
+}
+
+func (p *AddKubernetesSupportedVersionParams) GetMincpunumber() (int, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["mincpunumber"].(int)
+ return value, ok
+}
+
+func (p *AddKubernetesSupportedVersionParams) SetMinmemory(v int) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["minmemory"] = v
+}
+
+func (p *AddKubernetesSupportedVersionParams) GetMinmemory() (int, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["minmemory"].(int)
+ return value, ok
+}
+
+func (p *AddKubernetesSupportedVersionParams) SetName(v string) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["name"] = v
+}
+
+func (p *AddKubernetesSupportedVersionParams) GetName() (string, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["name"].(string)
+ return value, ok
+}
+
+func (p *AddKubernetesSupportedVersionParams) SetSemanticversion(v string) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["semanticversion"] = v
+}
+
+func (p *AddKubernetesSupportedVersionParams) GetSemanticversion() (string, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["semanticversion"].(string)
+ return value, ok
+}
+
+func (p *AddKubernetesSupportedVersionParams) SetUrl(v string) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["url"] = v
+}
+
+func (p *AddKubernetesSupportedVersionParams) GetUrl() (string, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["url"].(string)
+ return value, ok
+}
+
+func (p *AddKubernetesSupportedVersionParams) SetZoneid(v string) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["zoneid"] = v
+}
+
+func (p *AddKubernetesSupportedVersionParams) GetZoneid() (string, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["zoneid"].(string)
+ return value, ok
+}
+
+// You should always use this function to get a new AddKubernetesSupportedVersionParams instance,
+// as then you are sure you have configured all required params
+func (s *KubernetesService) NewAddKubernetesSupportedVersionParams(mincpunumber int, minmemory int, semanticversion string) *AddKubernetesSupportedVersionParams {
+ p := &AddKubernetesSupportedVersionParams{}
+ p.p = make(map[string]interface{})
+ p.p["mincpunumber"] = mincpunumber
+ p.p["minmemory"] = minmemory
+ p.p["semanticversion"] = semanticversion
+ return p
+}
+
+// Add a supported Kubernetes version
+func (s *KubernetesService) AddKubernetesSupportedVersion(p *AddKubernetesSupportedVersionParams) (*AddKubernetesSupportedVersionResponse, error) {
+ resp, err := s.cs.newRequest("addKubernetesSupportedVersion", p.toURLValues())
+ if err != nil {
+ return nil, err
+ }
+
+ var r AddKubernetesSupportedVersionResponse
+ if err := json.Unmarshal(resp, &r); err != nil {
+ return nil, err
+ }
+
+ return &r, nil
+}
+
+type AddKubernetesSupportedVersionResponse struct {
+ Id string `json:"id"`
+ Isoid string `json:"isoid"`
+ Isoname string `json:"isoname"`
+ Isostate string `json:"isostate"`
+ JobID string `json:"jobid"`
+ Jobstatus int `json:"jobstatus"`
+ Mincpunumber int `json:"mincpunumber"`
+ Minmemory int `json:"minmemory"`
+ Name string `json:"name"`
+ Semanticversion string `json:"semanticversion"`
+ State string `json:"state"`
+ Supportsautoscaling bool `json:"supportsautoscaling"`
+ Supportsha bool `json:"supportsha"`
+ Zoneid string `json:"zoneid"`
+ Zonename string `json:"zonename"`
+}
+
+type CreateKubernetesClusterParams struct {
+ p map[string]interface{}
+}
+
+func (p *CreateKubernetesClusterParams) toURLValues() url.Values {
+ u := url.Values{}
+ if p.p == nil {
+ return u
+ }
+ if v, found := p.p["account"]; found {
+ u.Set("account", v.(string))
+ }
+ if v, found := p.p["controlnodes"]; found {
+ vv := strconv.FormatInt(v.(int64), 10)
+ u.Set("controlnodes", vv)
+ }
+ if v, found := p.p["description"]; found {
+ u.Set("description", v.(string))
+ }
+ if v, found := p.p["dockerregistryemail"]; found {
+ u.Set("dockerregistryemail", v.(string))
+ }
+ if v, found := p.p["dockerregistrypassword"]; found {
+ u.Set("dockerregistrypassword", v.(string))
+ }
+ if v, found := p.p["dockerregistryurl"]; found {
+ u.Set("dockerregistryurl", v.(string))
+ }
+ if v, found := p.p["dockerregistryusername"]; found {
+ u.Set("dockerregistryusername", v.(string))
+ }
+ if v, found := p.p["domainid"]; found {
+ u.Set("domainid", v.(string))
+ }
+ if v, found := p.p["externalloadbalanceripaddress"]; found {
+ u.Set("externalloadbalanceripaddress", v.(string))
+ }
+ if v, found := p.p["keypair"]; found {
+ u.Set("keypair", v.(string))
+ }
+ if v, found := p.p["kubernetesversionid"]; found {
+ u.Set("kubernetesversionid", v.(string))
+ }
+ if v, found := p.p["masternodes"]; found {
+ vv := strconv.FormatInt(v.(int64), 10)
+ u.Set("masternodes", vv)
+ }
+ if v, found := p.p["name"]; found {
+ u.Set("name", v.(string))
+ }
+ if v, found := p.p["networkid"]; found {
+ u.Set("networkid", v.(string))
+ }
+ if v, found := p.p["noderootdisksize"]; found {
+ vv := strconv.FormatInt(v.(int64), 10)
+ u.Set("noderootdisksize", vv)
+ }
+ if v, found := p.p["projectid"]; found {
+ u.Set("projectid", v.(string))
+ }
+ if v, found := p.p["serviceofferingid"]; found {
+ u.Set("serviceofferingid", v.(string))
+ }
+ if v, found := p.p["size"]; found {
+ vv := strconv.FormatInt(v.(int64), 10)
+ u.Set("size", vv)
+ }
+ if v, found := p.p["zoneid"]; found {
+ u.Set("zoneid", v.(string))
+ }
+ return u
+}
+
+func (p *CreateKubernetesClusterParams) SetAccount(v string) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["account"] = v
+}
+
+func (p *CreateKubernetesClusterParams) GetAccount() (string, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["account"].(string)
+ return value, ok
+}
+
+func (p *CreateKubernetesClusterParams) SetControlnodes(v int64) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["controlnodes"] = v
+}
+
+func (p *CreateKubernetesClusterParams) GetControlnodes() (int64, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["controlnodes"].(int64)
+ return value, ok
+}
+
+func (p *CreateKubernetesClusterParams) SetDescription(v string) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["description"] = v
+}
+
+func (p *CreateKubernetesClusterParams) GetDescription() (string, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["description"].(string)
+ return value, ok
+}
+
+func (p *CreateKubernetesClusterParams) SetDockerregistryemail(v string) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["dockerregistryemail"] = v
+}
+
+func (p *CreateKubernetesClusterParams) GetDockerregistryemail() (string, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["dockerregistryemail"].(string)
+ return value, ok
+}
+
+func (p *CreateKubernetesClusterParams) SetDockerregistrypassword(v string) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["dockerregistrypassword"] = v
+}
+
+func (p *CreateKubernetesClusterParams) GetDockerregistrypassword() (string, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["dockerregistrypassword"].(string)
+ return value, ok
+}
+
+func (p *CreateKubernetesClusterParams) SetDockerregistryurl(v string) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["dockerregistryurl"] = v
+}
+
+func (p *CreateKubernetesClusterParams) GetDockerregistryurl() (string, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["dockerregistryurl"].(string)
+ return value, ok
+}
+
+func (p *CreateKubernetesClusterParams) SetDockerregistryusername(v string) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["dockerregistryusername"] = v
+}
+
+func (p *CreateKubernetesClusterParams) GetDockerregistryusername() (string, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["dockerregistryusername"].(string)
+ return value, ok
+}
+
+func (p *CreateKubernetesClusterParams) SetDomainid(v string) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["domainid"] = v
+}
+
+func (p *CreateKubernetesClusterParams) GetDomainid() (string, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["domainid"].(string)
+ return value, ok
+}
+
+func (p *CreateKubernetesClusterParams) SetExternalloadbalanceripaddress(v string) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["externalloadbalanceripaddress"] = v
+}
+
+func (p *CreateKubernetesClusterParams) GetExternalloadbalanceripaddress() (string, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["externalloadbalanceripaddress"].(string)
+ return value, ok
+}
+
+func (p *CreateKubernetesClusterParams) SetKeypair(v string) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["keypair"] = v
+}
+
+func (p *CreateKubernetesClusterParams) GetKeypair() (string, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["keypair"].(string)
+ return value, ok
+}
+
+func (p *CreateKubernetesClusterParams) SetKubernetesversionid(v string) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["kubernetesversionid"] = v
+}
+
+func (p *CreateKubernetesClusterParams) GetKubernetesversionid() (string, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["kubernetesversionid"].(string)
+ return value, ok
+}
+
+func (p *CreateKubernetesClusterParams) SetMasternodes(v int64) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["masternodes"] = v
+}
+
+func (p *CreateKubernetesClusterParams) GetMasternodes() (int64, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["masternodes"].(int64)
+ return value, ok
+}
+
+func (p *CreateKubernetesClusterParams) SetName(v string) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["name"] = v
+}
+
+func (p *CreateKubernetesClusterParams) GetName() (string, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["name"].(string)
+ return value, ok
+}
+
+func (p *CreateKubernetesClusterParams) SetNetworkid(v string) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["networkid"] = v
+}
+
+func (p *CreateKubernetesClusterParams) GetNetworkid() (string, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["networkid"].(string)
+ return value, ok
+}
+
+func (p *CreateKubernetesClusterParams) SetNoderootdisksize(v int64) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["noderootdisksize"] = v
+}
+
+func (p *CreateKubernetesClusterParams) GetNoderootdisksize() (int64, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["noderootdisksize"].(int64)
+ return value, ok
+}
+
+func (p *CreateKubernetesClusterParams) SetProjectid(v string) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["projectid"] = v
+}
+
+func (p *CreateKubernetesClusterParams) GetProjectid() (string, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["projectid"].(string)
+ return value, ok
+}
+
+func (p *CreateKubernetesClusterParams) SetServiceofferingid(v string) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["serviceofferingid"] = v
+}
+
+func (p *CreateKubernetesClusterParams) GetServiceofferingid() (string, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["serviceofferingid"].(string)
+ return value, ok
+}
+
+func (p *CreateKubernetesClusterParams) SetSize(v int64) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["size"] = v
+}
+
+func (p *CreateKubernetesClusterParams) GetSize() (int64, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["size"].(int64)
+ return value, ok
+}
+
+func (p *CreateKubernetesClusterParams) SetZoneid(v string) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["zoneid"] = v
+}
+
+func (p *CreateKubernetesClusterParams) GetZoneid() (string, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["zoneid"].(string)
+ return value, ok
+}
+
+// You should always use this function to get a new CreateKubernetesClusterParams instance,
+// as then you are sure you have configured all required params
+func (s *KubernetesService) NewCreateKubernetesClusterParams(description string, kubernetesversionid string, name string, serviceofferingid string, size int64, zoneid string) *CreateKubernetesClusterParams {
+ p := &CreateKubernetesClusterParams{}
+ p.p = make(map[string]interface{})
+ p.p["description"] = description
+ p.p["kubernetesversionid"] = kubernetesversionid
+ p.p["name"] = name
+ p.p["serviceofferingid"] = serviceofferingid
+ p.p["size"] = size
+ p.p["zoneid"] = zoneid
+ return p
+}
+
+// Creates a Kubernetes cluster
+func (s *KubernetesService) CreateKubernetesCluster(p *CreateKubernetesClusterParams) (*CreateKubernetesClusterResponse, error) {
+ resp, err := s.cs.newRequest("createKubernetesCluster", p.toURLValues())
+ if err != nil {
+ return nil, err
+ }
+
+ var r CreateKubernetesClusterResponse
+ if err := json.Unmarshal(resp, &r); err != nil {
+ return nil, err
+ }
+
+ // If we have a async client, we need to wait for the async result
+ if s.cs.async {
+ b, err := s.cs.GetAsyncJobResult(r.JobID, s.cs.timeout)
+ if err != nil {
+ if err == AsyncTimeoutErr {
+ return &r, err
+ }
+ return nil, err
+ }
+
+ b, err = getRawValue(b)
+ if err != nil {
+ return nil, err
+ }
+
+ if err := json.Unmarshal(b, &r); err != nil {
+ return nil, err
+ }
+ }
+
+ return &r, nil
+}
+
+type CreateKubernetesClusterResponse struct {
+ Account string `json:"account"`
+ Associatednetworkname string `json:"associatednetworkname"`
+ Autoscalingenabled bool `json:"autoscalingenabled"`
+ Consoleendpoint string `json:"consoleendpoint"`
+ Controlnodes int64 `json:"controlnodes"`
+ Cpunumber string `json:"cpunumber"`
+ Description string `json:"description"`
+ Domain string `json:"domain"`
+ Domainid string `json:"domainid"`
+ Endpoint string `json:"endpoint"`
+ Hasannotations bool `json:"hasannotations"`
+ Id string `json:"id"`
+ Ipaddress string `json:"ipaddress"`
+ Ipaddressid string `json:"ipaddressid"`
+ JobID string `json:"jobid"`
+ Jobstatus int `json:"jobstatus"`
+ Keypair string `json:"keypair"`
+ Kubernetesversionid string `json:"kubernetesversionid"`
+ Kubernetesversionname string `json:"kubernetesversionname"`
+ Masternodes int64 `json:"masternodes"`
+ Maxsize int64 `json:"maxsize"`
+ Memory string `json:"memory"`
+ Minsize int64 `json:"minsize"`
+ Name string `json:"name"`
+ Networkid string `json:"networkid"`
+ Project string `json:"project"`
+ Projectid string `json:"projectid"`
+ Serviceofferingid string `json:"serviceofferingid"`
+ Serviceofferingname string `json:"serviceofferingname"`
+ Size int64 `json:"size"`
+ State string `json:"state"`
+ Templateid string `json:"templateid"`
+ Virtualmachines []string `json:"virtualmachines"`
+ Zoneid string `json:"zoneid"`
+ Zonename string `json:"zonename"`
+}
+
+type DeleteKubernetesClusterParams struct {
+ p map[string]interface{}
+}
+
+func (p *DeleteKubernetesClusterParams) toURLValues() url.Values {
+ u := url.Values{}
+ if p.p == nil {
+ return u
+ }
+ if v, found := p.p["id"]; found {
+ u.Set("id", v.(string))
+ }
+ return u
+}
+
+func (p *DeleteKubernetesClusterParams) SetId(v string) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["id"] = v
+}
+
+func (p *DeleteKubernetesClusterParams) GetId() (string, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["id"].(string)
+ return value, ok
+}
+
+// You should always use this function to get a new DeleteKubernetesClusterParams instance,
+// as then you are sure you have configured all required params
+func (s *KubernetesService) NewDeleteKubernetesClusterParams(id string) *DeleteKubernetesClusterParams {
+ p := &DeleteKubernetesClusterParams{}
+ p.p = make(map[string]interface{})
+ p.p["id"] = id
+ return p
+}
+
+// Deletes a Kubernetes cluster
+func (s *KubernetesService) DeleteKubernetesCluster(p *DeleteKubernetesClusterParams) (*DeleteKubernetesClusterResponse, error) {
+ resp, err := s.cs.newRequest("deleteKubernetesCluster", p.toURLValues())
+ if err != nil {
+ return nil, err
+ }
+
+ var r DeleteKubernetesClusterResponse
+ if err := json.Unmarshal(resp, &r); err != nil {
+ return nil, err
+ }
+
+ // If we have a async client, we need to wait for the async result
+ if s.cs.async {
+ b, err := s.cs.GetAsyncJobResult(r.JobID, s.cs.timeout)
+ if err != nil {
+ if err == AsyncTimeoutErr {
+ return &r, err
+ }
+ return nil, err
+ }
+
+ if err := json.Unmarshal(b, &r); err != nil {
+ return nil, err
+ }
+ }
+
+ return &r, nil
+}
+
+type DeleteKubernetesClusterResponse struct {
+ Displaytext string `json:"displaytext"`
+ JobID string `json:"jobid"`
+ Jobstatus int `json:"jobstatus"`
+ Success bool `json:"success"`
+}
+
+type DeleteKubernetesSupportedVersionParams struct {
+ p map[string]interface{}
+}
+
+func (p *DeleteKubernetesSupportedVersionParams) toURLValues() url.Values {
+ u := url.Values{}
+ if p.p == nil {
+ return u
+ }
+ if v, found := p.p["id"]; found {
+ u.Set("id", v.(string))
+ }
+ return u
+}
+
+func (p *DeleteKubernetesSupportedVersionParams) SetId(v string) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["id"] = v
+}
+
+func (p *DeleteKubernetesSupportedVersionParams) GetId() (string, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["id"].(string)
+ return value, ok
+}
+
+// You should always use this function to get a new DeleteKubernetesSupportedVersionParams instance,
+// as then you are sure you have configured all required params
+func (s *KubernetesService) NewDeleteKubernetesSupportedVersionParams(id string) *DeleteKubernetesSupportedVersionParams {
+ p := &DeleteKubernetesSupportedVersionParams{}
+ p.p = make(map[string]interface{})
+ p.p["id"] = id
+ return p
+}
+
+// Deletes a Kubernetes cluster
+func (s *KubernetesService) DeleteKubernetesSupportedVersion(p *DeleteKubernetesSupportedVersionParams) (*DeleteKubernetesSupportedVersionResponse, error) {
+ resp, err := s.cs.newRequest("deleteKubernetesSupportedVersion", p.toURLValues())
+ if err != nil {
+ return nil, err
+ }
+
+ var r DeleteKubernetesSupportedVersionResponse
+ if err := json.Unmarshal(resp, &r); err != nil {
+ return nil, err
+ }
+
+ // If we have a async client, we need to wait for the async result
+ if s.cs.async {
+ b, err := s.cs.GetAsyncJobResult(r.JobID, s.cs.timeout)
+ if err != nil {
+ if err == AsyncTimeoutErr {
+ return &r, err
+ }
+ return nil, err
+ }
+
+ if err := json.Unmarshal(b, &r); err != nil {
+ return nil, err
+ }
+ }
+
+ return &r, nil
+}
+
+type DeleteKubernetesSupportedVersionResponse struct {
+ Displaytext string `json:"displaytext"`
+ JobID string `json:"jobid"`
+ Jobstatus int `json:"jobstatus"`
+ Success bool `json:"success"`
+}
+
+type GetKubernetesClusterConfigParams struct {
+ p map[string]interface{}
+}
+
+func (p *GetKubernetesClusterConfigParams) toURLValues() url.Values {
+ u := url.Values{}
+ if p.p == nil {
+ return u
+ }
+ if v, found := p.p["id"]; found {
+ u.Set("id", v.(string))
+ }
+ return u
+}
+
+func (p *GetKubernetesClusterConfigParams) SetId(v string) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["id"] = v
+}
+
+func (p *GetKubernetesClusterConfigParams) GetId() (string, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["id"].(string)
+ return value, ok
+}
+
+// You should always use this function to get a new GetKubernetesClusterConfigParams instance,
+// as then you are sure you have configured all required params
+func (s *KubernetesService) NewGetKubernetesClusterConfigParams() *GetKubernetesClusterConfigParams {
+ p := &GetKubernetesClusterConfigParams{}
+ p.p = make(map[string]interface{})
+ return p
+}
+
+// Get Kubernetes cluster config
+func (s *KubernetesService) GetKubernetesClusterConfig(p *GetKubernetesClusterConfigParams) (*GetKubernetesClusterConfigResponse, error) {
+ resp, err := s.cs.newRequest("getKubernetesClusterConfig", p.toURLValues())
+ if err != nil {
+ return nil, err
+ }
+
+ var r GetKubernetesClusterConfigResponse
+ if err := json.Unmarshal(resp, &r); err != nil {
+ return nil, err
+ }
+
+ return &r, nil
+}
+
+type GetKubernetesClusterConfigResponse struct {
+ Configdata string `json:"configdata"`
+ Id string `json:"id"`
+ JobID string `json:"jobid"`
+ Jobstatus int `json:"jobstatus"`
+ Name string `json:"name"`
+}
+
+type ListKubernetesClustersParams struct {
+ p map[string]interface{}
+}
+
+func (p *ListKubernetesClustersParams) toURLValues() url.Values {
+ u := url.Values{}
+ if p.p == nil {
+ return u
+ }
+ if v, found := p.p["account"]; found {
+ u.Set("account", v.(string))
+ }
+ if v, found := p.p["domainid"]; found {
+ u.Set("domainid", v.(string))
+ }
+ if v, found := p.p["id"]; found {
+ u.Set("id", v.(string))
+ }
+ if v, found := p.p["isrecursive"]; found {
+ vv := strconv.FormatBool(v.(bool))
+ u.Set("isrecursive", vv)
+ }
+ if v, found := p.p["keyword"]; found {
+ u.Set("keyword", v.(string))
+ }
+ if v, found := p.p["listall"]; found {
+ vv := strconv.FormatBool(v.(bool))
+ u.Set("listall", vv)
+ }
+ if v, found := p.p["name"]; found {
+ u.Set("name", v.(string))
+ }
+ if v, found := p.p["page"]; found {
+ vv := strconv.Itoa(v.(int))
+ u.Set("page", vv)
+ }
+ if v, found := p.p["pagesize"]; found {
+ vv := strconv.Itoa(v.(int))
+ u.Set("pagesize", vv)
+ }
+ if v, found := p.p["projectid"]; found {
+ u.Set("projectid", v.(string))
+ }
+ if v, found := p.p["state"]; found {
+ u.Set("state", v.(string))
+ }
+ return u
+}
+
+func (p *ListKubernetesClustersParams) SetAccount(v string) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["account"] = v
+}
+
+func (p *ListKubernetesClustersParams) GetAccount() (string, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["account"].(string)
+ return value, ok
+}
+
+func (p *ListKubernetesClustersParams) SetDomainid(v string) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["domainid"] = v
+}
+
+func (p *ListKubernetesClustersParams) GetDomainid() (string, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["domainid"].(string)
+ return value, ok
+}
+
+func (p *ListKubernetesClustersParams) SetId(v string) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["id"] = v
+}
+
+func (p *ListKubernetesClustersParams) GetId() (string, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["id"].(string)
+ return value, ok
+}
+
+func (p *ListKubernetesClustersParams) SetIsrecursive(v bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["isrecursive"] = v
+}
+
+func (p *ListKubernetesClustersParams) GetIsrecursive() (bool, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["isrecursive"].(bool)
+ return value, ok
+}
+
+func (p *ListKubernetesClustersParams) SetKeyword(v string) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["keyword"] = v
+}
+
+func (p *ListKubernetesClustersParams) GetKeyword() (string, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["keyword"].(string)
+ return value, ok
+}
+
+func (p *ListKubernetesClustersParams) SetListall(v bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["listall"] = v
+}
+
+func (p *ListKubernetesClustersParams) GetListall() (bool, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["listall"].(bool)
+ return value, ok
+}
+
+func (p *ListKubernetesClustersParams) SetName(v string) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["name"] = v
+}
+
+func (p *ListKubernetesClustersParams) GetName() (string, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["name"].(string)
+ return value, ok
+}
+
+func (p *ListKubernetesClustersParams) SetPage(v int) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["page"] = v
+}
+
+func (p *ListKubernetesClustersParams) GetPage() (int, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["page"].(int)
+ return value, ok
+}
+
+func (p *ListKubernetesClustersParams) SetPagesize(v int) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["pagesize"] = v
+}
+
+func (p *ListKubernetesClustersParams) GetPagesize() (int, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["pagesize"].(int)
+ return value, ok
+}
+
+func (p *ListKubernetesClustersParams) SetProjectid(v string) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["projectid"] = v
+}
+
+func (p *ListKubernetesClustersParams) GetProjectid() (string, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["projectid"].(string)
+ return value, ok
+}
+
+func (p *ListKubernetesClustersParams) SetState(v string) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["state"] = v
+}
+
+func (p *ListKubernetesClustersParams) GetState() (string, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["state"].(string)
+ return value, ok
+}
+
+// You should always use this function to get a new ListKubernetesClustersParams instance,
+// as then you are sure you have configured all required params
+func (s *KubernetesService) NewListKubernetesClustersParams() *ListKubernetesClustersParams {
+ p := &ListKubernetesClustersParams{}
+ p.p = make(map[string]interface{})
+ return p
+}
+
+// This is a courtesy helper function, which in some cases may not work as expected!
+func (s *KubernetesService) GetKubernetesClusterID(name string, opts ...OptionFunc) (string, int, error) {
+ p := &ListKubernetesClustersParams{}
+ p.p = make(map[string]interface{})
+
+ p.p["name"] = name
+
+ for _, fn := range append(s.cs.options, opts...) {
+ if err := fn(s.cs, p); err != nil {
+ return "", -1, err
+ }
+ }
+
+ l, err := s.ListKubernetesClusters(p)
+ if err != nil {
+ return "", -1, err
+ }
+
+ if l.Count == 0 {
+ return "", l.Count, fmt.Errorf("No match found for %s: %+v", name, l)
+ }
+
+ if l.Count == 1 {
+ return l.KubernetesClusters[0].Id, l.Count, nil
+ }
+
+ if l.Count > 1 {
+ for _, v := range l.KubernetesClusters {
+ if v.Name == name {
+ return v.Id, l.Count, nil
+ }
+ }
+ }
+ return "", l.Count, fmt.Errorf("Could not find an exact match for %s: %+v", name, l)
+}
+
+// This is a courtesy helper function, which in some cases may not work as expected!
+func (s *KubernetesService) GetKubernetesClusterByName(name string, opts ...OptionFunc) (*KubernetesCluster, int, error) {
+ id, count, err := s.GetKubernetesClusterID(name, opts...)
+ if err != nil {
+ return nil, count, err
+ }
+
+ r, count, err := s.GetKubernetesClusterByID(id, opts...)
+ if err != nil {
+ return nil, count, err
+ }
+ return r, count, nil
+}
+
+// This is a courtesy helper function, which in some cases may not work as expected!
+func (s *KubernetesService) GetKubernetesClusterByID(id string, opts ...OptionFunc) (*KubernetesCluster, int, error) {
+ p := &ListKubernetesClustersParams{}
+ p.p = make(map[string]interface{})
+
+ p.p["id"] = id
+
+ for _, fn := range append(s.cs.options, opts...) {
+ if err := fn(s.cs, p); err != nil {
+ return nil, -1, err
+ }
+ }
+
+ l, err := s.ListKubernetesClusters(p)
+ if err != nil {
+ if strings.Contains(err.Error(), fmt.Sprintf(
+ "Invalid parameter id value=%s due to incorrect long value format, "+
+ "or entity does not exist", id)) {
+ return nil, 0, fmt.Errorf("No match found for %s: %+v", id, l)
+ }
+ return nil, -1, err
+ }
+
+ if l.Count == 0 {
+ return nil, l.Count, fmt.Errorf("No match found for %s: %+v", id, l)
+ }
+
+ if l.Count == 1 {
+ return l.KubernetesClusters[0], l.Count, nil
+ }
+ return nil, l.Count, fmt.Errorf("There is more then one result for KubernetesCluster UUID: %s!", id)
+}
+
+// Lists Kubernetes clusters
+func (s *KubernetesService) ListKubernetesClusters(p *ListKubernetesClustersParams) (*ListKubernetesClustersResponse, error) {
+ resp, err := s.cs.newRequest("listKubernetesClusters", p.toURLValues())
+ if err != nil {
+ return nil, err
+ }
+
+ var r ListKubernetesClustersResponse
+ if err := json.Unmarshal(resp, &r); err != nil {
+ return nil, err
+ }
+
+ return &r, nil
+}
+
+type ListKubernetesClustersResponse struct {
+ Count int `json:"count"`
+ KubernetesClusters []*KubernetesCluster `json:"kubernetescluster"`
+}
+
+type KubernetesCluster struct {
+ Account string `json:"account"`
+ Associatednetworkname string `json:"associatednetworkname"`
+ Autoscalingenabled bool `json:"autoscalingenabled"`
+ Consoleendpoint string `json:"consoleendpoint"`
+ Controlnodes int64 `json:"controlnodes"`
+ Cpunumber string `json:"cpunumber"`
+ Description string `json:"description"`
+ Domain string `json:"domain"`
+ Domainid string `json:"domainid"`
+ Endpoint string `json:"endpoint"`
+ Hasannotations bool `json:"hasannotations"`
+ Id string `json:"id"`
+ Ipaddress string `json:"ipaddress"`
+ Ipaddressid string `json:"ipaddressid"`
+ JobID string `json:"jobid"`
+ Jobstatus int `json:"jobstatus"`
+ Keypair string `json:"keypair"`
+ Kubernetesversionid string `json:"kubernetesversionid"`
+ Kubernetesversionname string `json:"kubernetesversionname"`
+ Masternodes int64 `json:"masternodes"`
+ Maxsize int64 `json:"maxsize"`
+ Memory string `json:"memory"`
+ Minsize int64 `json:"minsize"`
+ Name string `json:"name"`
+ Networkid string `json:"networkid"`
+ Project string `json:"project"`
+ Projectid string `json:"projectid"`
+ Serviceofferingid string `json:"serviceofferingid"`
+ Serviceofferingname string `json:"serviceofferingname"`
+ Size int64 `json:"size"`
+ State string `json:"state"`
+ Templateid string `json:"templateid"`
+ Virtualmachines []string `json:"virtualmachines"`
+ Zoneid string `json:"zoneid"`
+ Zonename string `json:"zonename"`
+}
+
+type ListKubernetesSupportedVersionsParams struct {
+ p map[string]interface{}
+}
+
+func (p *ListKubernetesSupportedVersionsParams) toURLValues() url.Values {
+ u := url.Values{}
+ if p.p == nil {
+ return u
+ }
+ if v, found := p.p["id"]; found {
+ u.Set("id", v.(string))
+ }
+ if v, found := p.p["keyword"]; found {
+ u.Set("keyword", v.(string))
+ }
+ if v, found := p.p["minimumkubernetesversionid"]; found {
+ u.Set("minimumkubernetesversionid", v.(string))
+ }
+ if v, found := p.p["minimumsemanticversion"]; found {
+ u.Set("minimumsemanticversion", v.(string))
+ }
+ if v, found := p.p["page"]; found {
+ vv := strconv.Itoa(v.(int))
+ u.Set("page", vv)
+ }
+ if v, found := p.p["pagesize"]; found {
+ vv := strconv.Itoa(v.(int))
+ u.Set("pagesize", vv)
+ }
+ if v, found := p.p["zoneid"]; found {
+ u.Set("zoneid", v.(string))
+ }
+ return u
+}
+
+func (p *ListKubernetesSupportedVersionsParams) SetId(v string) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["id"] = v
+}
+
+func (p *ListKubernetesSupportedVersionsParams) GetId() (string, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["id"].(string)
+ return value, ok
+}
+
+func (p *ListKubernetesSupportedVersionsParams) SetKeyword(v string) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["keyword"] = v
+}
+
+func (p *ListKubernetesSupportedVersionsParams) GetKeyword() (string, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["keyword"].(string)
+ return value, ok
+}
+
+func (p *ListKubernetesSupportedVersionsParams) SetMinimumkubernetesversionid(v string) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["minimumkubernetesversionid"] = v
+}
+
+func (p *ListKubernetesSupportedVersionsParams) GetMinimumkubernetesversionid() (string, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["minimumkubernetesversionid"].(string)
+ return value, ok
+}
+
+func (p *ListKubernetesSupportedVersionsParams) SetMinimumsemanticversion(v string) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["minimumsemanticversion"] = v
+}
+
+func (p *ListKubernetesSupportedVersionsParams) GetMinimumsemanticversion() (string, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["minimumsemanticversion"].(string)
+ return value, ok
+}
+
+func (p *ListKubernetesSupportedVersionsParams) SetPage(v int) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["page"] = v
+}
+
+func (p *ListKubernetesSupportedVersionsParams) GetPage() (int, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["page"].(int)
+ return value, ok
+}
+
+func (p *ListKubernetesSupportedVersionsParams) SetPagesize(v int) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["pagesize"] = v
+}
+
+func (p *ListKubernetesSupportedVersionsParams) GetPagesize() (int, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["pagesize"].(int)
+ return value, ok
+}
+
+func (p *ListKubernetesSupportedVersionsParams) SetZoneid(v string) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["zoneid"] = v
+}
+
+func (p *ListKubernetesSupportedVersionsParams) GetZoneid() (string, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["zoneid"].(string)
+ return value, ok
+}
+
+// You should always use this function to get a new ListKubernetesSupportedVersionsParams instance,
+// as then you are sure you have configured all required params
+func (s *KubernetesService) NewListKubernetesSupportedVersionsParams() *ListKubernetesSupportedVersionsParams {
+ p := &ListKubernetesSupportedVersionsParams{}
+ p.p = make(map[string]interface{})
+ return p
+}
+
+// This is a courtesy helper function, which in some cases may not work as expected!
+func (s *KubernetesService) GetKubernetesSupportedVersionID(keyword string, opts ...OptionFunc) (string, int, error) {
+ p := &ListKubernetesSupportedVersionsParams{}
+ p.p = make(map[string]interface{})
+
+ p.p["keyword"] = keyword
+
+ for _, fn := range append(s.cs.options, opts...) {
+ if err := fn(s.cs, p); err != nil {
+ return "", -1, err
+ }
+ }
+
+ l, err := s.ListKubernetesSupportedVersions(p)
+ if err != nil {
+ return "", -1, err
+ }
+
+ if l.Count == 0 {
+ return "", l.Count, fmt.Errorf("No match found for %s: %+v", keyword, l)
+ }
+
+ if l.Count == 1 {
+ return l.KubernetesSupportedVersions[0].Id, l.Count, nil
+ }
+
+ if l.Count > 1 {
+ for _, v := range l.KubernetesSupportedVersions {
+ if v.Name == keyword {
+ return v.Id, l.Count, nil
+ }
+ }
+ }
+ return "", l.Count, fmt.Errorf("Could not find an exact match for %s: %+v", keyword, l)
+}
+
+// This is a courtesy helper function, which in some cases may not work as expected!
+func (s *KubernetesService) GetKubernetesSupportedVersionByName(name string, opts ...OptionFunc) (*KubernetesSupportedVersion, int, error) {
+ id, count, err := s.GetKubernetesSupportedVersionID(name, opts...)
+ if err != nil {
+ return nil, count, err
+ }
+
+ r, count, err := s.GetKubernetesSupportedVersionByID(id, opts...)
+ if err != nil {
+ return nil, count, err
+ }
+ return r, count, nil
+}
+
+// This is a courtesy helper function, which in some cases may not work as expected!
+func (s *KubernetesService) GetKubernetesSupportedVersionByID(id string, opts ...OptionFunc) (*KubernetesSupportedVersion, int, error) {
+ p := &ListKubernetesSupportedVersionsParams{}
+ p.p = make(map[string]interface{})
+
+ p.p["id"] = id
+
+ for _, fn := range append(s.cs.options, opts...) {
+ if err := fn(s.cs, p); err != nil {
+ return nil, -1, err
+ }
+ }
+
+ l, err := s.ListKubernetesSupportedVersions(p)
+ if err != nil {
+ if strings.Contains(err.Error(), fmt.Sprintf(
+ "Invalid parameter id value=%s due to incorrect long value format, "+
+ "or entity does not exist", id)) {
+ return nil, 0, fmt.Errorf("No match found for %s: %+v", id, l)
+ }
+ return nil, -1, err
+ }
+
+ if l.Count == 0 {
+ return nil, l.Count, fmt.Errorf("No match found for %s: %+v", id, l)
+ }
+
+ if l.Count == 1 {
+ return l.KubernetesSupportedVersions[0], l.Count, nil
+ }
+ return nil, l.Count, fmt.Errorf("There is more then one result for KubernetesSupportedVersion UUID: %s!", id)
+}
+
+// Lists supported Kubernetes version
+func (s *KubernetesService) ListKubernetesSupportedVersions(p *ListKubernetesSupportedVersionsParams) (*ListKubernetesSupportedVersionsResponse, error) {
+ resp, err := s.cs.newRequest("listKubernetesSupportedVersions", p.toURLValues())
+ if err != nil {
+ return nil, err
+ }
+
+ var r ListKubernetesSupportedVersionsResponse
+ if err := json.Unmarshal(resp, &r); err != nil {
+ return nil, err
+ }
+
+ return &r, nil
+}
+
+type ListKubernetesSupportedVersionsResponse struct {
+ Count int `json:"count"`
+ KubernetesSupportedVersions []*KubernetesSupportedVersion `json:"kubernetessupportedversion"`
+}
+
+type KubernetesSupportedVersion struct {
+ Id string `json:"id"`
+ Isoid string `json:"isoid"`
+ Isoname string `json:"isoname"`
+ Isostate string `json:"isostate"`
+ JobID string `json:"jobid"`
+ Jobstatus int `json:"jobstatus"`
+ Mincpunumber int `json:"mincpunumber"`
+ Minmemory int `json:"minmemory"`
+ Name string `json:"name"`
+ Semanticversion string `json:"semanticversion"`
+ State string `json:"state"`
+ Supportsautoscaling bool `json:"supportsautoscaling"`
+ Supportsha bool `json:"supportsha"`
+ Zoneid string `json:"zoneid"`
+ Zonename string `json:"zonename"`
+}
+
+type ScaleKubernetesClusterParams struct {
+ p map[string]interface{}
+}
+
+func (p *ScaleKubernetesClusterParams) toURLValues() url.Values {
+ u := url.Values{}
+ if p.p == nil {
+ return u
+ }
+ if v, found := p.p["autoscalingenabled"]; found {
+ vv := strconv.FormatBool(v.(bool))
+ u.Set("autoscalingenabled", vv)
+ }
+ if v, found := p.p["id"]; found {
+ u.Set("id", v.(string))
+ }
+ if v, found := p.p["maxsize"]; found {
+ vv := strconv.FormatInt(v.(int64), 10)
+ u.Set("maxsize", vv)
+ }
+ if v, found := p.p["minsize"]; found {
+ vv := strconv.FormatInt(v.(int64), 10)
+ u.Set("minsize", vv)
+ }
+ if v, found := p.p["nodeids"]; found {
+ vv := strings.Join(v.([]string), ",")
+ u.Set("nodeids", vv)
+ }
+ if v, found := p.p["serviceofferingid"]; found {
+ u.Set("serviceofferingid", v.(string))
+ }
+ if v, found := p.p["size"]; found {
+ vv := strconv.FormatInt(v.(int64), 10)
+ u.Set("size", vv)
+ }
+ return u
+}
+
+func (p *ScaleKubernetesClusterParams) SetAutoscalingenabled(v bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["autoscalingenabled"] = v
+}
+
+func (p *ScaleKubernetesClusterParams) GetAutoscalingenabled() (bool, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["autoscalingenabled"].(bool)
+ return value, ok
+}
+
+func (p *ScaleKubernetesClusterParams) SetId(v string) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["id"] = v
+}
+
+func (p *ScaleKubernetesClusterParams) GetId() (string, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["id"].(string)
+ return value, ok
+}
+
+func (p *ScaleKubernetesClusterParams) SetMaxsize(v int64) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["maxsize"] = v
+}
+
+func (p *ScaleKubernetesClusterParams) GetMaxsize() (int64, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["maxsize"].(int64)
+ return value, ok
+}
+
+func (p *ScaleKubernetesClusterParams) SetMinsize(v int64) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["minsize"] = v
+}
+
+func (p *ScaleKubernetesClusterParams) GetMinsize() (int64, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["minsize"].(int64)
+ return value, ok
+}
+
+func (p *ScaleKubernetesClusterParams) SetNodeids(v []string) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["nodeids"] = v
+}
+
+func (p *ScaleKubernetesClusterParams) GetNodeids() ([]string, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["nodeids"].([]string)
+ return value, ok
+}
+
+func (p *ScaleKubernetesClusterParams) SetServiceofferingid(v string) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["serviceofferingid"] = v
+}
+
+func (p *ScaleKubernetesClusterParams) GetServiceofferingid() (string, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["serviceofferingid"].(string)
+ return value, ok
+}
+
+func (p *ScaleKubernetesClusterParams) SetSize(v int64) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["size"] = v
+}
+
+func (p *ScaleKubernetesClusterParams) GetSize() (int64, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["size"].(int64)
+ return value, ok
+}
+
+// You should always use this function to get a new ScaleKubernetesClusterParams instance,
+// as then you are sure you have configured all required params
+func (s *KubernetesService) NewScaleKubernetesClusterParams(id string) *ScaleKubernetesClusterParams {
+ p := &ScaleKubernetesClusterParams{}
+ p.p = make(map[string]interface{})
+ p.p["id"] = id
+ return p
+}
+
+// Scales a created, running or stopped Kubernetes cluster
+func (s *KubernetesService) ScaleKubernetesCluster(p *ScaleKubernetesClusterParams) (*ScaleKubernetesClusterResponse, error) {
+ resp, err := s.cs.newRequest("scaleKubernetesCluster", p.toURLValues())
+ if err != nil {
+ return nil, err
+ }
+
+ var r ScaleKubernetesClusterResponse
+ if err := json.Unmarshal(resp, &r); err != nil {
+ return nil, err
+ }
+
+ // If we have a async client, we need to wait for the async result
+ if s.cs.async {
+ b, err := s.cs.GetAsyncJobResult(r.JobID, s.cs.timeout)
+ if err != nil {
+ if err == AsyncTimeoutErr {
+ return &r, err
+ }
+ return nil, err
+ }
+
+ b, err = getRawValue(b)
+ if err != nil {
+ return nil, err
+ }
+
+ if err := json.Unmarshal(b, &r); err != nil {
+ return nil, err
+ }
+ }
+
+ return &r, nil
+}
+
+type ScaleKubernetesClusterResponse struct {
+ Account string `json:"account"`
+ Associatednetworkname string `json:"associatednetworkname"`
+ Autoscalingenabled bool `json:"autoscalingenabled"`
+ Consoleendpoint string `json:"consoleendpoint"`
+ Controlnodes int64 `json:"controlnodes"`
+ Cpunumber string `json:"cpunumber"`
+ Description string `json:"description"`
+ Domain string `json:"domain"`
+ Domainid string `json:"domainid"`
+ Endpoint string `json:"endpoint"`
+ Hasannotations bool `json:"hasannotations"`
+ Id string `json:"id"`
+ Ipaddress string `json:"ipaddress"`
+ Ipaddressid string `json:"ipaddressid"`
+ JobID string `json:"jobid"`
+ Jobstatus int `json:"jobstatus"`
+ Keypair string `json:"keypair"`
+ Kubernetesversionid string `json:"kubernetesversionid"`
+ Kubernetesversionname string `json:"kubernetesversionname"`
+ Masternodes int64 `json:"masternodes"`
+ Maxsize int64 `json:"maxsize"`
+ Memory string `json:"memory"`
+ Minsize int64 `json:"minsize"`
+ Name string `json:"name"`
+ Networkid string `json:"networkid"`
+ Project string `json:"project"`
+ Projectid string `json:"projectid"`
+ Serviceofferingid string `json:"serviceofferingid"`
+ Serviceofferingname string `json:"serviceofferingname"`
+ Size int64 `json:"size"`
+ State string `json:"state"`
+ Templateid string `json:"templateid"`
+ Virtualmachines []string `json:"virtualmachines"`
+ Zoneid string `json:"zoneid"`
+ Zonename string `json:"zonename"`
+}
+
+type StartKubernetesClusterParams struct {
+ p map[string]interface{}
+}
+
+func (p *StartKubernetesClusterParams) toURLValues() url.Values {
+ u := url.Values{}
+ if p.p == nil {
+ return u
+ }
+ if v, found := p.p["id"]; found {
+ u.Set("id", v.(string))
+ }
+ return u
+}
+
+func (p *StartKubernetesClusterParams) SetId(v string) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["id"] = v
+}
+
+func (p *StartKubernetesClusterParams) GetId() (string, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["id"].(string)
+ return value, ok
+}
+
+// You should always use this function to get a new StartKubernetesClusterParams instance,
+// as then you are sure you have configured all required params
+func (s *KubernetesService) NewStartKubernetesClusterParams(id string) *StartKubernetesClusterParams {
+ p := &StartKubernetesClusterParams{}
+ p.p = make(map[string]interface{})
+ p.p["id"] = id
+ return p
+}
+
+// Starts a stopped Kubernetes cluster
+func (s *KubernetesService) StartKubernetesCluster(p *StartKubernetesClusterParams) (*StartKubernetesClusterResponse, error) {
+ resp, err := s.cs.newRequest("startKubernetesCluster", p.toURLValues())
+ if err != nil {
+ return nil, err
+ }
+
+ var r StartKubernetesClusterResponse
+ if err := json.Unmarshal(resp, &r); err != nil {
+ return nil, err
+ }
+
+ // If we have a async client, we need to wait for the async result
+ if s.cs.async {
+ b, err := s.cs.GetAsyncJobResult(r.JobID, s.cs.timeout)
+ if err != nil {
+ if err == AsyncTimeoutErr {
+ return &r, err
+ }
+ return nil, err
+ }
+
+ b, err = getRawValue(b)
+ if err != nil {
+ return nil, err
+ }
+
+ if err := json.Unmarshal(b, &r); err != nil {
+ return nil, err
+ }
+ }
+
+ return &r, nil
+}
+
+type StartKubernetesClusterResponse struct {
+ Account string `json:"account"`
+ Associatednetworkname string `json:"associatednetworkname"`
+ Autoscalingenabled bool `json:"autoscalingenabled"`
+ Consoleendpoint string `json:"consoleendpoint"`
+ Controlnodes int64 `json:"controlnodes"`
+ Cpunumber string `json:"cpunumber"`
+ Description string `json:"description"`
+ Domain string `json:"domain"`
+ Domainid string `json:"domainid"`
+ Endpoint string `json:"endpoint"`
+ Hasannotations bool `json:"hasannotations"`
+ Id string `json:"id"`
+ Ipaddress string `json:"ipaddress"`
+ Ipaddressid string `json:"ipaddressid"`
+ JobID string `json:"jobid"`
+ Jobstatus int `json:"jobstatus"`
+ Keypair string `json:"keypair"`
+ Kubernetesversionid string `json:"kubernetesversionid"`
+ Kubernetesversionname string `json:"kubernetesversionname"`
+ Masternodes int64 `json:"masternodes"`
+ Maxsize int64 `json:"maxsize"`
+ Memory string `json:"memory"`
+ Minsize int64 `json:"minsize"`
+ Name string `json:"name"`
+ Networkid string `json:"networkid"`
+ Project string `json:"project"`
+ Projectid string `json:"projectid"`
+ Serviceofferingid string `json:"serviceofferingid"`
+ Serviceofferingname string `json:"serviceofferingname"`
+ Size int64 `json:"size"`
+ State string `json:"state"`
+ Templateid string `json:"templateid"`
+ Virtualmachines []string `json:"virtualmachines"`
+ Zoneid string `json:"zoneid"`
+ Zonename string `json:"zonename"`
+}
+
+type StopKubernetesClusterParams struct {
+ p map[string]interface{}
+}
+
+func (p *StopKubernetesClusterParams) toURLValues() url.Values {
+ u := url.Values{}
+ if p.p == nil {
+ return u
+ }
+ if v, found := p.p["id"]; found {
+ u.Set("id", v.(string))
+ }
+ return u
+}
+
+func (p *StopKubernetesClusterParams) SetId(v string) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["id"] = v
+}
+
+func (p *StopKubernetesClusterParams) GetId() (string, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["id"].(string)
+ return value, ok
+}
+
+// You should always use this function to get a new StopKubernetesClusterParams instance,
+// as then you are sure you have configured all required params
+func (s *KubernetesService) NewStopKubernetesClusterParams(id string) *StopKubernetesClusterParams {
+ p := &StopKubernetesClusterParams{}
+ p.p = make(map[string]interface{})
+ p.p["id"] = id
+ return p
+}
+
+// Stops a running Kubernetes cluster
+func (s *KubernetesService) StopKubernetesCluster(p *StopKubernetesClusterParams) (*StopKubernetesClusterResponse, error) {
+ resp, err := s.cs.newRequest("stopKubernetesCluster", p.toURLValues())
+ if err != nil {
+ return nil, err
+ }
+
+ var r StopKubernetesClusterResponse
+ if err := json.Unmarshal(resp, &r); err != nil {
+ return nil, err
+ }
+
+ // If we have a async client, we need to wait for the async result
+ if s.cs.async {
+ b, err := s.cs.GetAsyncJobResult(r.JobID, s.cs.timeout)
+ if err != nil {
+ if err == AsyncTimeoutErr {
+ return &r, err
+ }
+ return nil, err
+ }
+
+ if err := json.Unmarshal(b, &r); err != nil {
+ return nil, err
+ }
+ }
+
+ return &r, nil
+}
+
+type StopKubernetesClusterResponse struct {
+ Displaytext string `json:"displaytext"`
+ JobID string `json:"jobid"`
+ Jobstatus int `json:"jobstatus"`
+ Success bool `json:"success"`
+}
+
+type UpdateKubernetesSupportedVersionParams struct {
+ p map[string]interface{}
+}
+
+func (p *UpdateKubernetesSupportedVersionParams) toURLValues() url.Values {
+ u := url.Values{}
+ if p.p == nil {
+ return u
+ }
+ if v, found := p.p["id"]; found {
+ u.Set("id", v.(string))
+ }
+ if v, found := p.p["state"]; found {
+ u.Set("state", v.(string))
+ }
+ return u
+}
+
+func (p *UpdateKubernetesSupportedVersionParams) SetId(v string) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["id"] = v
+}
+
+func (p *UpdateKubernetesSupportedVersionParams) GetId() (string, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["id"].(string)
+ return value, ok
+}
+
+func (p *UpdateKubernetesSupportedVersionParams) SetState(v string) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["state"] = v
+}
+
+func (p *UpdateKubernetesSupportedVersionParams) GetState() (string, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["state"].(string)
+ return value, ok
+}
+
+// You should always use this function to get a new UpdateKubernetesSupportedVersionParams instance,
+// as then you are sure you have configured all required params
+func (s *KubernetesService) NewUpdateKubernetesSupportedVersionParams(id string, state string) *UpdateKubernetesSupportedVersionParams {
+ p := &UpdateKubernetesSupportedVersionParams{}
+ p.p = make(map[string]interface{})
+ p.p["id"] = id
+ p.p["state"] = state
+ return p
+}
+
+// Update a supported Kubernetes version
+func (s *KubernetesService) UpdateKubernetesSupportedVersion(p *UpdateKubernetesSupportedVersionParams) (*UpdateKubernetesSupportedVersionResponse, error) {
+ resp, err := s.cs.newRequest("updateKubernetesSupportedVersion", p.toURLValues())
+ if err != nil {
+ return nil, err
+ }
+
+ var r UpdateKubernetesSupportedVersionResponse
+ if err := json.Unmarshal(resp, &r); err != nil {
+ return nil, err
+ }
+
+ return &r, nil
+}
+
+type UpdateKubernetesSupportedVersionResponse struct {
+ Id string `json:"id"`
+ Isoid string `json:"isoid"`
+ Isoname string `json:"isoname"`
+ Isostate string `json:"isostate"`
+ JobID string `json:"jobid"`
+ Jobstatus int `json:"jobstatus"`
+ Mincpunumber int `json:"mincpunumber"`
+ Minmemory int `json:"minmemory"`
+ Name string `json:"name"`
+ Semanticversion string `json:"semanticversion"`
+ State string `json:"state"`
+ Supportsautoscaling bool `json:"supportsautoscaling"`
+ Supportsha bool `json:"supportsha"`
+ Zoneid string `json:"zoneid"`
+ Zonename string `json:"zonename"`
+}
+
+type UpgradeKubernetesClusterParams struct {
+ p map[string]interface{}
+}
+
+func (p *UpgradeKubernetesClusterParams) toURLValues() url.Values {
+ u := url.Values{}
+ if p.p == nil {
+ return u
+ }
+ if v, found := p.p["id"]; found {
+ u.Set("id", v.(string))
+ }
+ if v, found := p.p["kubernetesversionid"]; found {
+ u.Set("kubernetesversionid", v.(string))
+ }
+ return u
+}
+
+func (p *UpgradeKubernetesClusterParams) SetId(v string) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["id"] = v
+}
+
+func (p *UpgradeKubernetesClusterParams) GetId() (string, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["id"].(string)
+ return value, ok
+}
+
+func (p *UpgradeKubernetesClusterParams) SetKubernetesversionid(v string) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ p.p["kubernetesversionid"] = v
+}
+
+func (p *UpgradeKubernetesClusterParams) GetKubernetesversionid() (string, bool) {
+ if p.p == nil {
+ p.p = make(map[string]interface{})
+ }
+ value, ok := p.p["kubernetesversionid"].(string)
+ return value, ok
+}
+
+// You should always use this function to get a new UpgradeKubernetesClusterParams instance,
+// as then you are sure you have configured all required params
+func (s *KubernetesService) NewUpgradeKubernetesClusterParams(id string, kubernetesversionid string) *UpgradeKubernetesClusterParams {
+ p := &UpgradeKubernetesClusterParams{}
+ p.p = make(map[string]interface{})
+ p.p["id"] = id
+ p.p["kubernetesversionid"] = kubernetesversionid
+ return p
+}
+
+// Upgrades a running Kubernetes cluster
+func (s *KubernetesService) UpgradeKubernetesCluster(p *UpgradeKubernetesClusterParams) (*UpgradeKubernetesClusterResponse, error) {
+ resp, err := s.cs.newRequest("upgradeKubernetesCluster", p.toURLValues())
+ if err != nil {
+ return nil, err
+ }
+
+ var r UpgradeKubernetesClusterResponse
+ if err := json.Unmarshal(resp, &r); err != nil {
+ return nil, err
+ }
+
+ // If we have a async client, we need to wait for the async result
+ if s.cs.async {
+ b, err := s.cs.GetAsyncJobResult(r.JobID, s.cs.timeout)
+ if err != nil {
+ if err == AsyncTimeoutErr {
+ return &r, err
+ }
+ return nil, err
+ }
+
+ b, err = getRawValue(b)
+ if err != nil {
+ return nil, err
+ }
+
+ if err := json.Unmarshal(b, &r); err != nil {
+ return nil, err
+ }
+ }
+
+ return &r, nil
+}
+
+type UpgradeKubernetesClusterResponse struct {
+ Account string `json:"account"`
+ Associatednetworkname string `json:"associatednetworkname"`
+ Autoscalingenabled bool `json:"autoscalingenabled"`
+ Consoleendpoint string `json:"consoleendpoint"`
+ Controlnodes int64 `json:"controlnodes"`
+ Cpunumber string `json:"cpunumber"`
+ Description string `json:"description"`
+ Domain string `json:"domain"`
+ Domainid string `json:"domainid"`
+ Endpoint string `json:"endpoint"`
+ Hasannotations bool `json:"hasannotations"`
+ Id string `json:"id"`
+ Ipaddress string `json:"ipaddress"`
+ Ipaddressid string `json:"ipaddressid"`
+ JobID string `json:"jobid"`
+ Jobstatus int `json:"jobstatus"`
+ Keypair string `json:"keypair"`
+ Kubernetesversionid string `json:"kubernetesversionid"`
+ Kubernetesversionname string `json:"kubernetesversionname"`
+ Masternodes int64 `json:"masternodes"`
+ Maxsize int64 `json:"maxsize"`
+ Memory string `json:"memory"`
+ Minsize int64 `json:"minsize"`
+ Name string `json:"name"`
+ Networkid string `json:"networkid"`
+ Project string `json:"project"`
+ Projectid string `json:"projectid"`
+ Serviceofferingid string `json:"serviceofferingid"`
+ Serviceofferingname string `json:"serviceofferingname"`
+ Size int64 `json:"size"`
+ State string `json:"state"`
+ Templateid string `json:"templateid"`
+ Virtualmachines []string `json:"virtualmachines"`
+ Zoneid string `json:"zoneid"`
+ Zonename string `json:"zonename"`
+}
diff --git a/cloudstack/KubernetesService_mock.go b/cloudstack/KubernetesService_mock.go
new file mode 100644
index 0000000..0f6d5a3
--- /dev/null
+++ b/cloudstack/KubernetesService_mock.go
@@ -0,0 +1,527 @@
+//
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+//
+
+// Code generated by MockGen. DO NOT EDIT.
+// Source: ./cloudstack/KubernetesService.go
+
+// Package cloudstack is a generated GoMock package.
+package cloudstack
+
+import (
+ reflect "reflect"
+
+ gomock "github.com/golang/mock/gomock"
+)
+
+// MockKubernetesServiceIface is a mock of KubernetesServiceIface interface.
+type MockKubernetesServiceIface struct {
+ ctrl *gomock.Controller
+ recorder *MockKubernetesServiceIfaceMockRecorder
+}
+
+// MockKubernetesServiceIfaceMockRecorder is the mock recorder for MockKubernetesServiceIface.
+type MockKubernetesServiceIfaceMockRecorder struct {
+ mock *MockKubernetesServiceIface
+}
+
+// NewMockKubernetesServiceIface creates a new mock instance.
+func NewMockKubernetesServiceIface(ctrl *gomock.Controller) *MockKubernetesServiceIface {
+ mock := &MockKubernetesServiceIface{ctrl: ctrl}
+ mock.recorder = &MockKubernetesServiceIfaceMockRecorder{mock}
+ return mock
+}
+
+// EXPECT returns an object that allows the caller to indicate expected use.
+func (m *MockKubernetesServiceIface) EXPECT() *MockKubernetesServiceIfaceMockRecorder {
+ return m.recorder
+}
+
+// AddKubernetesSupportedVersion mocks base method.
+func (m *MockKubernetesServiceIface) AddKubernetesSupportedVersion(p *AddKubernetesSupportedVersionParams) (*AddKubernetesSupportedVersionResponse, error) {
+ m.ctrl.T.Helper()
+ ret := m.ctrl.Call(m, "AddKubernetesSupportedVersion", p)
+ ret0, _ := ret[0].(*AddKubernetesSupportedVersionResponse)
+ ret1, _ := ret[1].(error)
+ return ret0, ret1
+}
+
+// AddKubernetesSupportedVersion indicates an expected call of AddKubernetesSupportedVersion.
+func (mr *MockKubernetesServiceIfaceMockRecorder) AddKubernetesSupportedVersion(p interface{}) *gomock.Call {
+ mr.mock.ctrl.T.Helper()
+ return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "AddKubernetesSupportedVersion", reflect.TypeOf((*MockKubernetesServiceIface)(nil).AddKubernetesSupportedVersion), p)
+}
+
+// CreateKubernetesCluster mocks base method.
+func (m *MockKubernetesServiceIface) CreateKubernetesCluster(p *CreateKubernetesClusterParams) (*CreateKubernetesClusterResponse, error) {
+ m.ctrl.T.Helper()
+ ret := m.ctrl.Call(m, "CreateKubernetesCluster", p)
+ ret0, _ := ret[0].(*CreateKubernetesClusterResponse)
+ ret1, _ := ret[1].(error)
+ return ret0, ret1
+}
+
+// CreateKubernetesCluster indicates an expected call of CreateKubernetesCluster.
+func (mr *MockKubernetesServiceIfaceMockRecorder) CreateKubernetesCluster(p interface{}) *gomock.Call {
+ mr.mock.ctrl.T.Helper()
+ return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "CreateKubernetesCluster", reflect.TypeOf((*MockKubernetesServiceIface)(nil).CreateKubernetesCluster), p)
+}
+
+// DeleteKubernetesCluster mocks base method.
+func (m *MockKubernetesServiceIface) DeleteKubernetesCluster(p *DeleteKubernetesClusterParams) (*DeleteKubernetesClusterResponse, error) {
+ m.ctrl.T.Helper()
+ ret := m.ctrl.Call(m, "DeleteKubernetesCluster", p)
+ ret0, _ := ret[0].(*DeleteKubernetesClusterResponse)
+ ret1, _ := ret[1].(error)
+ return ret0, ret1
+}
+
+// DeleteKubernetesCluster indicates an expected call of DeleteKubernetesCluster.
+func (mr *MockKubernetesServiceIfaceMockRecorder) DeleteKubernetesCluster(p interface{}) *gomock.Call {
+ mr.mock.ctrl.T.Helper()
+ return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "DeleteKubernetesCluster", reflect.TypeOf((*MockKubernetesServiceIface)(nil).DeleteKubernetesCluster), p)
+}
+
+// DeleteKubernetesSupportedVersion mocks base method.
+func (m *MockKubernetesServiceIface) DeleteKubernetesSupportedVersion(p *DeleteKubernetesSupportedVersionParams) (*DeleteKubernetesSupportedVersionResponse, error) {
+ m.ctrl.T.Helper()
+ ret := m.ctrl.Call(m, "DeleteKubernetesSupportedVersion", p)
+ ret0, _ := ret[0].(*DeleteKubernetesSupportedVersionResponse)
+ ret1, _ := ret[1].(error)
+ return ret0, ret1
+}
+
+// DeleteKubernetesSupportedVersion indicates an expected call of DeleteKubernetesSupportedVersion.
+func (mr *MockKubernetesServiceIfaceMockRecorder) DeleteKubernetesSupportedVersion(p interface{}) *gomock.Call {
+ mr.mock.ctrl.T.Helper()
+ return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "DeleteKubernetesSupportedVersion", reflect.TypeOf((*MockKubernetesServiceIface)(nil).DeleteKubernetesSupportedVersion), p)
+}
+
+// GetKubernetesClusterByID mocks base method.
+func (m *MockKubernetesServiceIface) GetKubernetesClusterByID(id string, opts ...OptionFunc) (*KubernetesCluster, int, error) {
+ m.ctrl.T.Helper()
+ varargs := []interface{}{id}
+ for _, a := range opts {
+ varargs = append(varargs, a)
+ }
+ ret := m.ctrl.Call(m, "GetKubernetesClusterByID", varargs...)
+ ret0, _ := ret[0].(*KubernetesCluster)
+ ret1, _ := ret[1].(int)
+ ret2, _ := ret[2].(error)
+ return ret0, ret1, ret2
+}
+
+// GetKubernetesClusterByID indicates an expected call of GetKubernetesClusterByID.
+func (mr *MockKubernetesServiceIfaceMockRecorder) GetKubernetesClusterByID(id interface{}, opts ...interface{}) *gomock.Call {
+ mr.mock.ctrl.T.Helper()
+ varargs := append([]interface{}{id}, opts...)
+ return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetKubernetesClusterByID", reflect.TypeOf((*MockKubernetesServiceIface)(nil).GetKubernetesClusterByID), varargs...)
+}
+
+// GetKubernetesClusterByName mocks base method.
+func (m *MockKubernetesServiceIface) GetKubernetesClusterByName(name string, opts ...OptionFunc) (*KubernetesCluster, int, error) {
+ m.ctrl.T.Helper()
+ varargs := []interface{}{name}
+ for _, a := range opts {
+ varargs = append(varargs, a)
+ }
+ ret := m.ctrl.Call(m, "GetKubernetesClusterByName", varargs...)
+ ret0, _ := ret[0].(*KubernetesCluster)
+ ret1, _ := ret[1].(int)
+ ret2, _ := ret[2].(error)
+ return ret0, ret1, ret2
+}
+
+// GetKubernetesClusterByName indicates an expected call of GetKubernetesClusterByName.
+func (mr *MockKubernetesServiceIfaceMockRecorder) GetKubernetesClusterByName(name interface{}, opts ...interface{}) *gomock.Call {
+ mr.mock.ctrl.T.Helper()
+ varargs := append([]interface{}{name}, opts...)
+ return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetKubernetesClusterByName", reflect.TypeOf((*MockKubernetesServiceIface)(nil).GetKubernetesClusterByName), varargs...)
+}
+
+// GetKubernetesClusterConfig mocks base method.
+func (m *MockKubernetesServiceIface) GetKubernetesClusterConfig(p *GetKubernetesClusterConfigParams) (*GetKubernetesClusterConfigResponse, error) {
+ m.ctrl.T.Helper()
+ ret := m.ctrl.Call(m, "GetKubernetesClusterConfig", p)
+ ret0, _ := ret[0].(*GetKubernetesClusterConfigResponse)
+ ret1, _ := ret[1].(error)
+ return ret0, ret1
+}
+
+// GetKubernetesClusterConfig indicates an expected call of GetKubernetesClusterConfig.
+func (mr *MockKubernetesServiceIfaceMockRecorder) GetKubernetesClusterConfig(p interface{}) *gomock.Call {
+ mr.mock.ctrl.T.Helper()
+ return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetKubernetesClusterConfig", reflect.TypeOf((*MockKubernetesServiceIface)(nil).GetKubernetesClusterConfig), p)
+}
+
+// GetKubernetesClusterID mocks base method.
+func (m *MockKubernetesServiceIface) GetKubernetesClusterID(name string, opts ...OptionFunc) (string, int, error) {
+ m.ctrl.T.Helper()
+ varargs := []interface{}{name}
+ for _, a := range opts {
+ varargs = append(varargs, a)
+ }
+ ret := m.ctrl.Call(m, "GetKubernetesClusterID", varargs...)
+ ret0, _ := ret[0].(string)
+ ret1, _ := ret[1].(int)
+ ret2, _ := ret[2].(error)
+ return ret0, ret1, ret2
+}
+
+// GetKubernetesClusterID indicates an expected call of GetKubernetesClusterID.
+func (mr *MockKubernetesServiceIfaceMockRecorder) GetKubernetesClusterID(name interface{}, opts ...interface{}) *gomock.Call {
+ mr.mock.ctrl.T.Helper()
+ varargs := append([]interface{}{name}, opts...)
+ return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetKubernetesClusterID", reflect.TypeOf((*MockKubernetesServiceIface)(nil).GetKubernetesClusterID), varargs...)
+}
+
+// GetKubernetesSupportedVersionByID mocks base method.
+func (m *MockKubernetesServiceIface) GetKubernetesSupportedVersionByID(id string, opts ...OptionFunc) (*KubernetesSupportedVersion, int, error) {
+ m.ctrl.T.Helper()
+ varargs := []interface{}{id}
+ for _, a := range opts {
+ varargs = append(varargs, a)
+ }
+ ret := m.ctrl.Call(m, "GetKubernetesSupportedVersionByID", varargs...)
+ ret0, _ := ret[0].(*KubernetesSupportedVersion)
+ ret1, _ := ret[1].(int)
+ ret2, _ := ret[2].(error)
+ return ret0, ret1, ret2
+}
+
+// GetKubernetesSupportedVersionByID indicates an expected call of GetKubernetesSupportedVersionByID.
+func (mr *MockKubernetesServiceIfaceMockRecorder) GetKubernetesSupportedVersionByID(id interface{}, opts ...interface{}) *gomock.Call {
+ mr.mock.ctrl.T.Helper()
+ varargs := append([]interface{}{id}, opts...)
+ return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetKubernetesSupportedVersionByID", reflect.TypeOf((*MockKubernetesServiceIface)(nil).GetKubernetesSupportedVersionByID), varargs...)
+}
+
+// GetKubernetesSupportedVersionByName mocks base method.
+func (m *MockKubernetesServiceIface) GetKubernetesSupportedVersionByName(name string, opts ...OptionFunc) (*KubernetesSupportedVersion, int, error) {
+ m.ctrl.T.Helper()
+ varargs := []interface{}{name}
+ for _, a := range opts {
+ varargs = append(varargs, a)
+ }
+ ret := m.ctrl.Call(m, "GetKubernetesSupportedVersionByName", varargs...)
+ ret0, _ := ret[0].(*KubernetesSupportedVersion)
+ ret1, _ := ret[1].(int)
+ ret2, _ := ret[2].(error)
+ return ret0, ret1, ret2
+}
+
+// GetKubernetesSupportedVersionByName indicates an expected call of GetKubernetesSupportedVersionByName.
+func (mr *MockKubernetesServiceIfaceMockRecorder) GetKubernetesSupportedVersionByName(name interface{}, opts ...interface{}) *gomock.Call {
+ mr.mock.ctrl.T.Helper()
+ varargs := append([]interface{}{name}, opts...)
+ return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetKubernetesSupportedVersionByName", reflect.TypeOf((*MockKubernetesServiceIface)(nil).GetKubernetesSupportedVersionByName), varargs...)
+}
+
+// GetKubernetesSupportedVersionID mocks base method.
+func (m *MockKubernetesServiceIface) GetKubernetesSupportedVersionID(keyword string, opts ...OptionFunc) (string, int, error) {
+ m.ctrl.T.Helper()
+ varargs := []interface{}{keyword}
+ for _, a := range opts {
+ varargs = append(varargs, a)
+ }
+ ret := m.ctrl.Call(m, "GetKubernetesSupportedVersionID", varargs...)
+ ret0, _ := ret[0].(string)
+ ret1, _ := ret[1].(int)
+ ret2, _ := ret[2].(error)
+ return ret0, ret1, ret2
+}
+
+// GetKubernetesSupportedVersionID indicates an expected call of GetKubernetesSupportedVersionID.
+func (mr *MockKubernetesServiceIfaceMockRecorder) GetKubernetesSupportedVersionID(keyword interface{}, opts ...interface{}) *gomock.Call {
+ mr.mock.ctrl.T.Helper()
+ varargs := append([]interface{}{keyword}, opts...)
+ return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetKubernetesSupportedVersionID", reflect.TypeOf((*MockKubernetesServiceIface)(nil).GetKubernetesSupportedVersionID), varargs...)
+}
+
+// ListKubernetesClusters mocks base method.
+func (m *MockKubernetesServiceIface) ListKubernetesClusters(p *ListKubernetesClustersParams) (*ListKubernetesClustersResponse, error) {
+ m.ctrl.T.Helper()
+ ret := m.ctrl.Call(m, "ListKubernetesClusters", p)
+ ret0, _ := ret[0].(*ListKubernetesClustersResponse)
+ ret1, _ := ret[1].(error)
+ return ret0, ret1
+}
+
+// ListKubernetesClusters indicates an expected call of ListKubernetesClusters.
+func (mr *MockKubernetesServiceIfaceMockRecorder) ListKubernetesClusters(p interface{}) *gomock.Call {
+ mr.mock.ctrl.T.Helper()
+ return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ListKubernetesClusters", reflect.TypeOf((*MockKubernetesServiceIface)(nil).ListKubernetesClusters), p)
+}
+
+// ListKubernetesSupportedVersions mocks base method.
+func (m *MockKubernetesServiceIface) ListKubernetesSupportedVersions(p *ListKubernetesSupportedVersionsParams) (*ListKubernetesSupportedVersionsResponse, error) {
+ m.ctrl.T.Helper()
+ ret := m.ctrl.Call(m, "ListKubernetesSupportedVersions", p)
+ ret0, _ := ret[0].(*ListKubernetesSupportedVersionsResponse)
+ ret1, _ := ret[1].(error)
+ return ret0, ret1
+}
+
+// ListKubernetesSupportedVersions indicates an expected call of ListKubernetesSupportedVersions.
+func (mr *MockKubernetesServiceIfaceMockRecorder) ListKubernetesSupportedVersions(p interface{}) *gomock.Call {
+ mr.mock.ctrl.T.Helper()
+ return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ListKubernetesSupportedVersions", reflect.TypeOf((*MockKubernetesServiceIface)(nil).ListKubernetesSupportedVersions), p)
+}
+
+// NewAddKubernetesSupportedVersionParams mocks base method.
+func (m *MockKubernetesServiceIface) NewAddKubernetesSupportedVersionParams(mincpunumber, minmemory int, semanticversion string) *AddKubernetesSupportedVersionParams {
+ m.ctrl.T.Helper()
+ ret := m.ctrl.Call(m, "NewAddKubernetesSupportedVersionParams", mincpunumber, minmemory, semanticversion)
+ ret0, _ := ret[0].(*AddKubernetesSupportedVersionParams)
+ return ret0
+}
+
+// NewAddKubernetesSupportedVersionParams indicates an expected call of NewAddKubernetesSupportedVersionParams.
+func (mr *MockKubernetesServiceIfaceMockRecorder) NewAddKubernetesSupportedVersionParams(mincpunumber, minmemory, semanticversion interface{}) *gomock.Call {
+ mr.mock.ctrl.T.Helper()
+ return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewAddKubernetesSupportedVersionParams", reflect.TypeOf((*MockKubernetesServiceIface)(nil).NewAddKubernetesSupportedVersionParams), mincpunumber, minmemory, semanticversion)
+}
+
+// NewCreateKubernetesClusterParams mocks base method.
+func (m *MockKubernetesServiceIface) NewCreateKubernetesClusterParams(description, kubernetesversionid, name, serviceofferingid string, size int64, zoneid string) *CreateKubernetesClusterParams {
+ m.ctrl.T.Helper()
+ ret := m.ctrl.Call(m, "NewCreateKubernetesClusterParams", description, kubernetesversionid, name, serviceofferingid, size, zoneid)
+ ret0, _ := ret[0].(*CreateKubernetesClusterParams)
+ return ret0
+}
+
+// NewCreateKubernetesClusterParams indicates an expected call of NewCreateKubernetesClusterParams.
+func (mr *MockKubernetesServiceIfaceMockRecorder) NewCreateKubernetesClusterParams(description, kubernetesversionid, name, serviceofferingid, size, zoneid interface{}) *gomock.Call {
+ mr.mock.ctrl.T.Helper()
+ return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewCreateKubernetesClusterParams", reflect.TypeOf((*MockKubernetesServiceIface)(nil).NewCreateKubernetesClusterParams), description, kubernetesversionid, name, serviceofferingid, size, zoneid)
+}
+
+// NewDeleteKubernetesClusterParams mocks base method.
+func (m *MockKubernetesServiceIface) NewDeleteKubernetesClusterParams(id string) *DeleteKubernetesClusterParams {
+ m.ctrl.T.Helper()
+ ret := m.ctrl.Call(m, "NewDeleteKubernetesClusterParams", id)
+ ret0, _ := ret[0].(*DeleteKubernetesClusterParams)
+ return ret0
+}
+
+// NewDeleteKubernetesClusterParams indicates an expected call of NewDeleteKubernetesClusterParams.
+func (mr *MockKubernetesServiceIfaceMockRecorder) NewDeleteKubernetesClusterParams(id interface{}) *gomock.Call {
+ mr.mock.ctrl.T.Helper()
+ return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewDeleteKubernetesClusterParams", reflect.TypeOf((*MockKubernetesServiceIface)(nil).NewDeleteKubernetesClusterParams), id)
+}
+
+// NewDeleteKubernetesSupportedVersionParams mocks base method.
+func (m *MockKubernetesServiceIface) NewDeleteKubernetesSupportedVersionParams(id string) *DeleteKubernetesSupportedVersionParams {
+ m.ctrl.T.Helper()
+ ret := m.ctrl.Call(m, "NewDeleteKubernetesSupportedVersionParams", id)
+ ret0, _ := ret[0].(*DeleteKubernetesSupportedVersionParams)
+ return ret0
+}
+
+// NewDeleteKubernetesSupportedVersionParams indicates an expected call of NewDeleteKubernetesSupportedVersionParams.
+func (mr *MockKubernetesServiceIfaceMockRecorder) NewDeleteKubernetesSupportedVersionParams(id interface{}) *gomock.Call {
+ mr.mock.ctrl.T.Helper()
+ return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewDeleteKubernetesSupportedVersionParams", reflect.TypeOf((*MockKubernetesServiceIface)(nil).NewDeleteKubernetesSupportedVersionParams), id)
+}
+
+// NewGetKubernetesClusterConfigParams mocks base method.
+func (m *MockKubernetesServiceIface) NewGetKubernetesClusterConfigParams() *GetKubernetesClusterConfigParams {
+ m.ctrl.T.Helper()
+ ret := m.ctrl.Call(m, "NewGetKubernetesClusterConfigParams")
+ ret0, _ := ret[0].(*GetKubernetesClusterConfigParams)
+ return ret0
+}
+
+// NewGetKubernetesClusterConfigParams indicates an expected call of NewGetKubernetesClusterConfigParams.
+func (mr *MockKubernetesServiceIfaceMockRecorder) NewGetKubernetesClusterConfigParams() *gomock.Call {
+ mr.mock.ctrl.T.Helper()
+ return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewGetKubernetesClusterConfigParams", reflect.TypeOf((*MockKubernetesServiceIface)(nil).NewGetKubernetesClusterConfigParams))
+}
+
+// NewListKubernetesClustersParams mocks base method.
+func (m *MockKubernetesServiceIface) NewListKubernetesClustersParams() *ListKubernetesClustersParams {
+ m.ctrl.T.Helper()
+ ret := m.ctrl.Call(m, "NewListKubernetesClustersParams")
+ ret0, _ := ret[0].(*ListKubernetesClustersParams)
+ return ret0
+}
+
+// NewListKubernetesClustersParams indicates an expected call of NewListKubernetesClustersParams.
+func (mr *MockKubernetesServiceIfaceMockRecorder) NewListKubernetesClustersParams() *gomock.Call {
+ mr.mock.ctrl.T.Helper()
+ return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewListKubernetesClustersParams", reflect.TypeOf((*MockKubernetesServiceIface)(nil).NewListKubernetesClustersParams))
+}
+
+// NewListKubernetesSupportedVersionsParams mocks base method.
+func (m *MockKubernetesServiceIface) NewListKubernetesSupportedVersionsParams() *ListKubernetesSupportedVersionsParams {
+ m.ctrl.T.Helper()
+ ret := m.ctrl.Call(m, "NewListKubernetesSupportedVersionsParams")
+ ret0, _ := ret[0].(*ListKubernetesSupportedVersionsParams)
+ return ret0
+}
+
+// NewListKubernetesSupportedVersionsParams indicates an expected call of NewListKubernetesSupportedVersionsParams.
+func (mr *MockKubernetesServiceIfaceMockRecorder) NewListKubernetesSupportedVersionsParams() *gomock.Call {
+ mr.mock.ctrl.T.Helper()
+ return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewListKubernetesSupportedVersionsParams", reflect.TypeOf((*MockKubernetesServiceIface)(nil).NewListKubernetesSupportedVersionsParams))
+}
+
+// NewScaleKubernetesClusterParams mocks base method.
+func (m *MockKubernetesServiceIface) NewScaleKubernetesClusterParams(id string) *ScaleKubernetesClusterParams {
+ m.ctrl.T.Helper()
+ ret := m.ctrl.Call(m, "NewScaleKubernetesClusterParams", id)
+ ret0, _ := ret[0].(*ScaleKubernetesClusterParams)
+ return ret0
+}
+
+// NewScaleKubernetesClusterParams indicates an expected call of NewScaleKubernetesClusterParams.
+func (mr *MockKubernetesServiceIfaceMockRecorder) NewScaleKubernetesClusterParams(id interface{}) *gomock.Call {
+ mr.mock.ctrl.T.Helper()
+ return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewScaleKubernetesClusterParams", reflect.TypeOf((*MockKubernetesServiceIface)(nil).NewScaleKubernetesClusterParams), id)
+}
+
+// NewStartKubernetesClusterParams mocks base method.
+func (m *MockKubernetesServiceIface) NewStartKubernetesClusterParams(id string) *StartKubernetesClusterParams {
+ m.ctrl.T.Helper()
+ ret := m.ctrl.Call(m, "NewStartKubernetesClusterParams", id)
+ ret0, _ := ret[0].(*StartKubernetesClusterParams)
+ return ret0
+}
+
+// NewStartKubernetesClusterParams indicates an expected call of NewStartKubernetesClusterParams.
+func (mr *MockKubernetesServiceIfaceMockRecorder) NewStartKubernetesClusterParams(id interface{}) *gomock.Call {
+ mr.mock.ctrl.T.Helper()
+ return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewStartKubernetesClusterParams", reflect.TypeOf((*MockKubernetesServiceIface)(nil).NewStartKubernetesClusterParams), id)
+}
+
+// NewStopKubernetesClusterParams mocks base method.
+func (m *MockKubernetesServiceIface) NewStopKubernetesClusterParams(id string) *StopKubernetesClusterParams {
+ m.ctrl.T.Helper()
+ ret := m.ctrl.Call(m, "NewStopKubernetesClusterParams", id)
+ ret0, _ := ret[0].(*StopKubernetesClusterParams)
+ return ret0
+}
+
+// NewStopKubernetesClusterParams indicates an expected call of NewStopKubernetesClusterParams.
+func (mr *MockKubernetesServiceIfaceMockRecorder) NewStopKubernetesClusterParams(id interface{}) *gomock.Call {
+ mr.mock.ctrl.T.Helper()
+ return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewStopKubernetesClusterParams", reflect.TypeOf((*MockKubernetesServiceIface)(nil).NewStopKubernetesClusterParams), id)
+}
+
+// NewUpdateKubernetesSupportedVersionParams mocks base method.
+func (m *MockKubernetesServiceIface) NewUpdateKubernetesSupportedVersionParams(id, state string) *UpdateKubernetesSupportedVersionParams {
+ m.ctrl.T.Helper()
+ ret := m.ctrl.Call(m, "NewUpdateKubernetesSupportedVersionParams", id, state)
+ ret0, _ := ret[0].(*UpdateKubernetesSupportedVersionParams)
+ return ret0
+}
+
+// NewUpdateKubernetesSupportedVersionParams indicates an expected call of NewUpdateKubernetesSupportedVersionParams.
+func (mr *MockKubernetesServiceIfaceMockRecorder) NewUpdateKubernetesSupportedVersionParams(id, state interface{}) *gomock.Call {
+ mr.mock.ctrl.T.Helper()
+ return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewUpdateKubernetesSupportedVersionParams", reflect.TypeOf((*MockKubernetesServiceIface)(nil).NewUpdateKubernetesSupportedVersionParams), id, state)
+}
+
+// NewUpgradeKubernetesClusterParams mocks base method.
+func (m *MockKubernetesServiceIface) NewUpgradeKubernetesClusterParams(id, kubernetesversionid string) *UpgradeKubernetesClusterParams {
+ m.ctrl.T.Helper()
+ ret := m.ctrl.Call(m, "NewUpgradeKubernetesClusterParams", id, kubernetesversionid)
+ ret0, _ := ret[0].(*UpgradeKubernetesClusterParams)
+ return ret0
+}
+
+// NewUpgradeKubernetesClusterParams indicates an expected call of NewUpgradeKubernetesClusterParams.
+func (mr *MockKubernetesServiceIfaceMockRecorder) NewUpgradeKubernetesClusterParams(id, kubernetesversionid interface{}) *gomock.Call {
+ mr.mock.ctrl.T.Helper()
+ return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewUpgradeKubernetesClusterParams", reflect.TypeOf((*MockKubernetesServiceIface)(nil).NewUpgradeKubernetesClusterParams), id, kubernetesversionid)
+}
+
+// ScaleKubernetesCluster mocks base method.
+func (m *MockKubernetesServiceIface) ScaleKubernetesCluster(p *ScaleKubernetesClusterParams) (*ScaleKubernetesClusterResponse, error) {
+ m.ctrl.T.Helper()
+ ret := m.ctrl.Call(m, "ScaleKubernetesCluster", p)
+ ret0, _ := ret[0].(*ScaleKubernetesClusterResponse)
+ ret1, _ := ret[1].(error)
+ return ret0, ret1
+}
+
+// ScaleKubernetesCluster indicates an expected call of ScaleKubernetesCluster.
+func (mr *MockKubernetesServiceIfaceMockRecorder) ScaleKubernetesCluster(p interface{}) *gomock.Call {
+ mr.mock.ctrl.T.Helper()
+ return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ScaleKubernetesCluster", reflect.TypeOf((*MockKubernetesServiceIface)(nil).ScaleKubernetesCluster), p)
+}
+
+// StartKubernetesCluster mocks base method.
+func (m *MockKubernetesServiceIface) StartKubernetesCluster(p *StartKubernetesClusterParams) (*StartKubernetesClusterResponse, error) {
+ m.ctrl.T.Helper()
+ ret := m.ctrl.Call(m, "StartKubernetesCluster", p)
+ ret0, _ := ret[0].(*StartKubernetesClusterResponse)
+ ret1, _ := ret[1].(error)
+ return ret0, ret1
+}
+
+// StartKubernetesCluster indicates an expected call of StartKubernetesCluster.
+func (mr *MockKubernetesServiceIfaceMockRecorder) StartKubernetesCluster(p interface{}) *gomock.Call {
+ mr.mock.ctrl.T.Helper()
+ return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "StartKubernetesCluster", reflect.TypeOf((*MockKubernetesServiceIface)(nil).StartKubernetesCluster), p)
+}
+
+// StopKubernetesCluster mocks base method.
+func (m *MockKubernetesServiceIface) StopKubernetesCluster(p *StopKubernetesClusterParams) (*StopKubernetesClusterResponse, error) {
+ m.ctrl.T.Helper()
+ ret := m.ctrl.Call(m, "StopKubernetesCluster", p)
+ ret0, _ := ret[0].(*StopKubernetesClusterResponse)
+ ret1, _ := ret[1].(error)
+ return ret0, ret1
+}
+
+// StopKubernetesCluster indicates an expected call of StopKubernetesCluster.
+func (mr *MockKubernetesServiceIfaceMockRecorder) StopKubernetesCluster(p interface{}) *gomock.Call {
+ mr.mock.ctrl.T.Helper()
+ return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "StopKubernetesCluster", reflect.TypeOf((*MockKubernetesServiceIface)(nil).StopKubernetesCluster), p)
+}
+
+// UpdateKubernetesSupportedVersion mocks base method.
+func (m *MockKubernetesServiceIface) UpdateKubernetesSupportedVersion(p *UpdateKubernetesSupportedVersionParams) (*UpdateKubernetesSupportedVersionResponse, error) {
+ m.ctrl.T.Helper()
+ ret := m.ctrl.Call(m, "UpdateKubernetesSupportedVersion", p)
+ ret0, _ := ret[0].(*UpdateKubernetesSupportedVersionResponse)
+ ret1, _ := ret[1].(error)
+ return ret0, ret1
+}
+
+// UpdateKubernetesSupportedVersion indicates an expected call of UpdateKubernetesSupportedVersion.
+func (mr *MockKubernetesServiceIfaceMockRecorder) UpdateKubernetesSupportedVersion(p interface{}) *gomock.Call {
+ mr.mock.ctrl.T.Helper()
+ return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "UpdateKubernetesSupportedVersion", reflect.TypeOf((*MockKubernetesServiceIface)(nil).UpdateKubernetesSupportedVersion), p)
+}
+
+// UpgradeKubernetesCluster mocks base method.
+func (m *MockKubernetesServiceIface) UpgradeKubernetesCluster(p *UpgradeKubernetesClusterParams) (*UpgradeKubernetesClusterResponse, error) {
+ m.ctrl.T.Helper()
+ ret := m.ctrl.Call(m, "UpgradeKubernetesCluster", p)
+ ret0, _ := ret[0].(*UpgradeKubernetesClusterResponse)
+ ret1, _ := ret[1].(error)
+ return ret0, ret1
+}
+
+// UpgradeKubernetesCluster indicates an expected call of UpgradeKubernetesCluster.
+func (mr *MockKubernetesServiceIfaceMockRecorder) UpgradeKubernetesCluster(p interface{}) *gomock.Call {
+ mr.mock.ctrl.T.Helper()
+ return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "UpgradeKubernetesCluster", reflect.TypeOf((*MockKubernetesServiceIface)(nil).UpgradeKubernetesCluster), p)
+}
diff --git a/cloudstack/cloudstack.go b/cloudstack/cloudstack.go
index 4933845..c3e5587 100644
--- a/cloudstack/cloudstack.go
+++ b/cloudstack/cloudstack.go
@@ -125,6 +125,7 @@
ISO ISOServiceIface
ImageStore ImageStoreServiceIface
InternalLB InternalLBServiceIface
+ Kubernetes KubernetesServiceIface
LDAP LDAPServiceIface
Limit LimitServiceIface
LoadBalancer LoadBalancerServiceIface
@@ -228,6 +229,7 @@
cs.ISO = NewISOService(cs)
cs.ImageStore = NewImageStoreService(cs)
cs.InternalLB = NewInternalLBService(cs)
+ cs.Kubernetes = NewKubernetesService(cs)
cs.LDAP = NewLDAPService(cs)
cs.Limit = NewLimitService(cs)
cs.LoadBalancer = NewLoadBalancerService(cs)
@@ -304,6 +306,7 @@
cs.ISO = NewMockISOServiceIface(ctrl)
cs.ImageStore = NewMockImageStoreServiceIface(ctrl)
cs.InternalLB = NewMockInternalLBServiceIface(ctrl)
+ cs.Kubernetes = NewMockKubernetesServiceIface(ctrl)
cs.LDAP = NewMockLDAPServiceIface(ctrl)
cs.Limit = NewMockLimitServiceIface(ctrl)
cs.LoadBalancer = NewMockLoadBalancerServiceIface(ctrl)
@@ -901,6 +904,14 @@
return &InternalLBService{cs: cs}
}
+type KubernetesService struct {
+ cs *CloudStackClient
+}
+
+func NewKubernetesService(cs *CloudStackClient) KubernetesServiceIface {
+ return &KubernetesService{cs: cs}
+}
+
type LDAPService struct {
cs *CloudStackClient
}
diff --git a/generate/layout.go b/generate/layout.go
index 6697420..a497372 100644
--- a/generate/layout.go
+++ b/generate/layout.go
@@ -110,6 +110,20 @@
"updateDefaultNicForVirtualMachine",
"updateVirtualMachine",
},
+ "KubernetesService": {
+ "addKubernetesSupportedVersion",
+ "createKubernetesCluster",
+ "deleteKubernetesCluster",
+ "deleteKubernetesSupportedVersion",
+ "getKubernetesClusterConfig",
+ "listKubernetesClusters",
+ "listKubernetesSupportedVersions",
+ "scaleKubernetesCluster",
+ "startKubernetesCluster",
+ "stopKubernetesCluster",
+ "updateKubernetesSupportedVersion",
+ "upgradeKubernetesCluster",
+ },
"VPNService": {
"addVpnUser",
"createRemoteAccessVpn",
diff --git a/generate/listApis.json b/generate/listApis.json
index 6081aac..cdfeb7b 100644
--- a/generate/listApis.json
+++ b/generate/listApis.json
@@ -24,11 +24,6 @@
"response": [
{},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
"description": "resource type",
"name": "resourcetype",
"type": "resourceobjecttype"
@@ -40,14 +35,19 @@
"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"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
}
],
"since": "4.16.0.0"
@@ -66,22 +66,6 @@
"type": "map"
},
{
- "description": "set to true if the offering is to be enabled during creation. Default is false",
- "length": 255,
- "name": "enable",
- "required": false,
- "since": "4.16",
- "type": "boolean"
- },
- {
- "description": "the ID of the service offering for the VPC router appliance",
- "length": 255,
- "name": "serviceofferingid",
- "related": "createServiceOffering,updateServiceOffering,listServiceOfferings",
- "required": false,
- "type": "uuid"
- },
- {
"description": "the name of the vpc offering",
"length": 255,
"name": "name",
@@ -89,21 +73,6 @@
"type": "string"
},
{
- "description": "the ID of the containing domain(s), null for public offerings",
- "length": 255,
- "name": "domainid",
- "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
- "required": false,
- "type": "list"
- },
- {
- "description": "services supported by the vpc offering",
- "length": 255,
- "name": "supportedservices",
- "required": true,
- "type": "list"
- },
- {
"description": "the ID of the containing zone(s), null for public offerings",
"length": 255,
"name": "zoneid",
@@ -113,18 +82,49 @@
"type": "list"
},
{
- "description": "provider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical network",
- "length": 255,
- "name": "serviceproviderlist",
- "required": false,
- "type": "map"
- },
- {
"description": "the display text of the vpc offering",
"length": 255,
"name": "displaytext",
"required": true,
"type": "string"
+ },
+ {
+ "description": "the ID of the service offering for the VPC router appliance",
+ "length": 255,
+ "name": "serviceofferingid",
+ "related": "createServiceOffering,updateServiceOffering,listServiceOfferings",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "the ID of the containing domain(s), null for public offerings",
+ "length": 255,
+ "name": "domainid",
+ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
+ "required": false,
+ "type": "list"
+ },
+ {
+ "description": "set to true if the offering is to be enabled during creation. Default is false",
+ "length": 255,
+ "name": "enable",
+ "required": false,
+ "since": "4.16",
+ "type": "boolean"
+ },
+ {
+ "description": "services supported by the vpc offering",
+ "length": 255,
+ "name": "supportedservices",
+ "required": true,
+ "type": "list"
+ },
+ {
+ "description": "provider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical network",
+ "length": 255,
+ "name": "serviceproviderlist",
+ "required": false,
+ "type": "map"
}
],
"related": "updateVPCOffering,listVPCOfferings",
@@ -135,47 +135,25 @@
"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 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": "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": "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 name of the vpc offering",
- "name": "name",
- "type": "string"
- },
- {
- "description": "true if vpc offering is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
- },
{
"description": "the list of supported services",
"name": "service",
@@ -185,13 +163,13 @@
"name": "capability",
"response": [
{
- "description": "the capability value",
- "name": "value",
+ "description": "the capability name",
+ "name": "name",
"type": "string"
},
{
- "description": "the capability name",
- "name": "name",
+ "description": "the capability value",
+ "name": "value",
"type": "string"
},
{
@@ -207,26 +185,6 @@
"name": "provider",
"response": [
{
- "description": "true if individual services can be enabled/disabled",
- "name": "canenableindividualservice",
- "type": "boolean"
- },
- {
- "description": "the physical network this belongs to",
- "name": "physicalnetworkid",
- "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",
"type": "string"
@@ -240,6 +198,26 @@
"description": "the destination physical network",
"name": "destinationphysicalnetworkid",
"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"
}
],
"type": "list"
@@ -253,11 +231,6 @@
"type": "list"
},
{
- "description": " indicates if the vpc offering supports distributed router for one-hop forwarding",
- "name": "distributedvpcrouter",
- "type": "boolean"
- },
- {
"description": " indicated if the offering can support region level vpc",
"name": "supportsregionLevelvpc",
"type": "boolean"
@@ -267,15 +240,42 @@
"name": "jobid",
"type": "string"
},
+ {},
+ {},
+ {
+ "description": "the name of the vpc offering",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "true if vpc offering is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
{
"description": "the date this vpc offering was created",
"name": "created",
"type": "date"
},
{
+ "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
+ "name": "zone",
+ "type": "string"
+ },
+ {
+ "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
+ "name": "domain",
+ "type": "string"
+ },
+ {
"description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
"name": "zoneid",
"type": "string"
+ },
+ {
+ "description": "the id of the vpc offering",
+ "name": "id",
+ "type": "string"
}
]
},
@@ -285,11 +285,12 @@
"name": "createPod",
"params": [
{
- "description": "the name of the Pod",
+ "description": "the Zone ID in which the Pod will be created",
"length": 255,
- "name": "name",
+ "name": "zoneid",
+ "related": "createZone,updateZone,listZones,listZones",
"required": true,
- "type": "string"
+ "type": "uuid"
},
{
"description": "the ending IP address for the Pod",
@@ -299,20 +300,6 @@
"type": "string"
},
{
- "description": "the netmask for the Pod",
- "length": 255,
- "name": "netmask",
- "required": true,
- "type": "string"
- },
- {
- "description": "Allocation state of this Pod for allocation of new resources",
- "length": 255,
- "name": "allocationstate",
- "required": false,
- "type": "string"
- },
- {
"description": "the gateway for the Pod",
"length": 255,
"name": "gateway",
@@ -327,19 +314,37 @@
"type": "string"
},
{
- "description": "the Zone ID in which the Pod will be created",
+ "description": "Allocation state of this Pod for allocation of new resources",
"length": 255,
- "name": "zoneid",
- "related": "createZone,updateZone,listZones,listZones",
+ "name": "allocationstate",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the name of the Pod",
+ "length": 255,
+ "name": "name",
"required": true,
- "type": "uuid"
+ "type": "string"
+ },
+ {
+ "description": "the netmask for the Pod",
+ "length": 255,
+ "name": "netmask",
+ "required": true,
+ "type": "string"
}
],
"related": "listPods,updatePod,createManagementNetworkIpRange",
"response": [
{
- "description": "the Zone ID of the Pod",
- "name": "zoneid",
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the ID of the Pod",
+ "name": "id",
"type": "string"
},
{
@@ -348,14 +353,9 @@
"type": "string"
},
{
- "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 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.",
@@ -363,121 +363,17 @@
"type": "list"
},
{
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {},
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the capacity of the Pod",
- "name": "capacity",
- "response": [
- {
- "description": "the capacity type",
- "name": "type",
- "type": "short"
- },
- {
- "description": "the Cluster name",
- "name": "clustername",
- "type": "string"
- },
- {
- "description": "the capacity name",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the capacity currently in allocated",
- "name": "capacityallocated",
- "type": "long"
- },
- {
- "description": "the Pod name",
- "name": "podname",
- "type": "string"
- },
- {
- "description": "the Zone name",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "the Zone ID",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the capacity currently in use",
- "name": "capacityused",
- "type": "long"
- },
- {
- "description": "the percentage of capacity currently in use",
- "name": "percentused",
- "type": "string"
- },
- {
- "description": "the Pod ID",
- "name": "podid",
- "type": "string"
- },
- {
- "description": "the Cluster ID",
- "name": "clusterid",
- "type": "string"
- },
- {
- "description": "the total capacity available",
- "name": "capacitytotal",
- "type": "long"
- }
- ],
- "type": "list"
- },
- {
- "description": "the name of the Pod",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the ID of the Pod",
- "name": "id",
- "type": "string"
- },
- {
"description": "the Zone name of the Pod",
"name": "zonename",
"type": "string"
},
- {},
- {
- "description": "the allocation state of the Pod",
- "name": "allocationstate",
- "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 starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.",
- "name": "startip",
- "type": "list"
- },
{
"description": "the IP ranges for the Pod",
"name": "ipranges",
"response": [
{
- "description": "the starting IP for the range",
- "name": "startip",
+ "description": "the ending IP for the range",
+ "name": "endip",
"type": "string"
},
{
@@ -486,22 +382,126 @@
"type": "string"
},
{
- "description": "indicates Vlan ID for the range",
- "name": "vlanid",
+ "description": "the starting IP for the range",
+ "name": "startip",
"type": "string"
},
{
- "description": "the ending IP for the range",
- "name": "endip",
+ "description": "indicates Vlan ID for the range",
+ "name": "vlanid",
"type": "string"
}
],
"type": "list"
},
{
+ "description": "the gateway of the Pod",
+ "name": "gateway",
+ "type": "string"
+ },
+ {
+ "description": "the Zone ID of the Pod",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the Pod",
+ "name": "name",
+ "type": "string"
+ },
+ {},
+ {
"description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.",
"name": "vlanid",
"type": "list"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.",
+ "name": "startip",
+ "type": "list"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the allocation state of the Pod",
+ "name": "allocationstate",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the capacity of the Pod",
+ "name": "capacity",
+ "response": [
+ {
+ "description": "the Cluster ID",
+ "name": "clusterid",
+ "type": "string"
+ },
+ {
+ "description": "the percentage of capacity currently in use",
+ "name": "percentused",
+ "type": "string"
+ },
+ {
+ "description": "the Zone ID",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the Cluster name",
+ "name": "clustername",
+ "type": "string"
+ },
+ {
+ "description": "the Pod ID",
+ "name": "podid",
+ "type": "string"
+ },
+ {
+ "description": "the Pod name",
+ "name": "podname",
+ "type": "string"
+ },
+ {
+ "description": "the total capacity available",
+ "name": "capacitytotal",
+ "type": "long"
+ },
+ {
+ "description": "the capacity type",
+ "name": "type",
+ "type": "short"
+ },
+ {
+ "description": "the capacity currently in use",
+ "name": "capacityused",
+ "type": "long"
+ },
+ {
+ "description": "the capacity name",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the Zone name",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "the capacity currently in allocated",
+ "name": "capacityallocated",
+ "type": "long"
+ }
+ ],
+ "type": "list"
}
]
},
@@ -511,6 +511,34 @@
"name": "ldapCreateAccount",
"params": [
{
+ "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin",
+ "length": 255,
+ "name": "accounttype",
+ "required": false,
+ "type": "short"
+ },
+ {
+ "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": false,
+ "type": "string"
+ },
+ {
+ "description": "Unique username.",
+ "length": 255,
+ "name": "username",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.",
+ "length": 255,
+ "name": "timezone",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "Network domain for the account's networks",
"length": 255,
"name": "networkdomain",
@@ -518,21 +546,6 @@
"type": "string"
},
{
- "description": "User UUID, required for adding account from external provisioning system",
- "length": 255,
- "name": "userid",
- "required": false,
- "type": "string"
- },
- {
- "description": "Creates the account under the specified role.",
- "length": 255,
- "name": "roleid",
- "related": "createRole,importRole,listRoles,updateRole",
- "required": false,
- "type": "uuid"
- },
- {
"description": "Creates the user under the specified domain.",
"length": 255,
"name": "domainid",
@@ -541,16 +554,9 @@
"type": "uuid"
},
{
- "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin",
+ "description": "User UUID, required for adding account from external provisioning system",
"length": 255,
- "name": "accounttype",
- "required": false,
- "type": "short"
- },
- {
- "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.",
- "length": 255,
- "name": "timezone",
+ "name": "userid",
"required": false,
"type": "string"
},
@@ -562,13 +568,6 @@
"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": false,
- "type": "string"
- },
- {
"description": "details for account used to store specific parameters",
"length": 255,
"name": "accountdetails",
@@ -576,33 +575,90 @@
"type": "map"
},
{
- "description": "Unique username.",
+ "description": "Creates the account under the specified role.",
"length": 255,
- "name": "username",
- "required": true,
- "type": "string"
+ "name": "roleid",
+ "related": "createRole,importRole,listRoles,updateRole",
+ "required": false,
+ "type": "uuid"
}
],
"related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts",
"response": [
{
- "description": "the total number of network traffic bytes sent",
- "name": "sentbytes",
+ "description": "the total number of network traffic bytes received",
+ "name": "receivedbytes",
"type": "long"
},
{
- "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",
+ "description": "the total secondary storage space (in GiB) the account can own",
+ "name": "secondarystoragelimit",
"type": "string"
},
{
- "description": "the network domain",
- "name": "networkdomain",
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the total number of virtual machines stopped for this account",
+ "name": "vmstopped",
+ "type": "integer"
+ },
+ {
+ "description": "the total secondary storage space (in GiB) available to be used for this account",
+ "name": "secondarystorageavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of templates which have been created by this account",
+ "name": "templatetotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of networks owned by account",
+ "name": "networktotal",
+ "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 public ip addresses available for this account to acquire",
+ "name": "ipavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total volume available for this account",
+ "name": "volumeavailable",
+ "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": "the ID of the role",
+ "name": "roleid",
+ "type": "string"
+ },
+ {
+ "description": "id of the Domain the account belongs to",
+ "name": "domainid",
"type": "string"
},
{
@@ -610,9 +666,9 @@
"name": "user",
"response": [
{
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
+ "description": "the source type of the user in lowercase, such as native, ldap, saml2",
+ "name": "usersource",
+ "type": "string"
},
{
"description": "the domain name of the user",
@@ -620,53 +676,13 @@
"type": "string"
},
{
- "description": "the ID of the role",
- "name": "roleid",
- "type": "string"
- },
- {
- "description": "the timezone user was created in",
- "name": "timezone",
- "type": "string"
- },
- {
- "description": "the user state",
- "name": "state",
- "type": "string"
- },
- {
- "description": "the user email address",
- "name": "email",
- "type": "string"
- },
- {
- "description": "the domain ID of the user",
- "name": "domainid",
- "type": "string"
- },
- {
"description": "the api key of the user",
"name": "apikey",
"type": "string"
},
{
- "description": "the user ID",
- "name": "id",
- "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 account name of the user",
- "name": "account",
+ "description": "the timezone user was created in",
+ "name": "timezone",
"type": "string"
},
{
@@ -675,18 +691,8 @@
"type": "string"
},
{
- "description": "the source type of the user in lowercase, such as native, ldap, saml2",
- "name": "usersource",
- "type": "string"
- },
- {
- "description": "true if user is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
- },
- {
- "description": "the user lastname",
- "name": "lastname",
+ "description": "the domain ID of the user",
+ "name": "domainid",
"type": "string"
},
{
@@ -695,9 +701,34 @@
"type": "boolean"
},
{
- "description": "the account type of the user",
- "name": "accounttype",
- "type": "short"
+ "description": "the user firstname",
+ "name": "firstname",
+ "type": "string"
+ },
+ {
+ "description": "the user email address",
+ "name": "email",
+ "type": "string"
+ },
+ {
+ "description": "the user name",
+ "name": "username",
+ "type": "string"
+ },
+ {
+ "description": "true if user is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {
+ "description": "the date and time the user account was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the ID of the role",
+ "name": "roleid",
+ "type": "string"
},
{
"description": "the type of the role",
@@ -705,6 +736,16 @@
"type": "string"
},
{
+ "description": "the user state",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
"description": "the name of the role",
"name": "rolename",
"type": "string"
@@ -715,141 +756,56 @@
"type": "string"
},
{
- "description": "the user firstname",
- "name": "firstname",
+ "description": "the user ID",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the account type of the user",
+ "name": "accounttype",
+ "type": "short"
+ },
+ {
+ "description": "the user lastname",
+ "name": "lastname",
+ "type": "string"
+ },
+ {
+ "description": "the account name of the user",
+ "name": "account",
"type": "string"
}
],
"type": "list"
},
{
- "description": "the total number of networks owned by account",
- "name": "networktotal",
- "type": "long"
- },
- {
- "description": "the total number of networks the account can own",
- "name": "networklimit",
+ "description": "the total number of virtual machines available for this account to acquire",
+ "name": "vmavailable",
"type": "string"
},
{
- "description": "the 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 account",
- "name": "vmtotal",
- "type": "long"
- },
- {
- "description": "the total number of vpcs the account can own",
- "name": "vpclimit",
+ "description": "the default zone of the account",
+ "name": "defaultzoneid",
"type": "string"
},
{
- "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",
- "type": "string"
- },
- {
- "description": "name of the Domain the account belongs to",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the name of the role",
- "name": "rolename",
- "type": "string"
- },
- {
- "description": "the total number of vpcs owned by account",
- "name": "vpctotal",
- "type": "long"
- },
- {
- "description": "the total memory (in MB) owned by account",
- "name": "memorytotal",
- "type": "long"
- },
- {
- "description": "the total primary storage space (in GiB) the account can own",
- "name": "primarystoragelimit",
- "type": "string"
- },
- {
- "description": "true if account is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
- },
- {
- "description": "path of the Domain the account belongs to",
- "name": "domainpath",
- "type": "string"
- },
- {
- "description": "the total number of projects the account can own",
- "name": "projectlimit",
- "type": "string"
- },
- {
- "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)",
- "name": "roletype",
- "type": "string"
- },
- {
- "description": "the total number of projects available for administration by this account",
- "name": "projectavailable",
- "type": "string"
- },
- {
- "description": "the date when this account was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the state of the account",
- "name": "state",
- "type": "string"
- },
- {
- "description": "details for the account",
- "name": "accountdetails",
- "type": "map"
- },
- {
"description": "the total volume which can be used by this account",
"name": "volumelimit",
"type": "string"
},
{
- "description": "the id of the account",
- "name": "id",
+ "description": "the total number of vpcs the account can own",
+ "name": "vpclimit",
"type": "string"
},
{
- "description": "the list of acl groups that account belongs to",
- "name": "groups",
- "type": "list"
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
},
{
- "description": "the total volume available for this account",
- "name": "volumeavailable",
- "type": "string"
- },
- {
- "description": "the total primary storage space (in GiB) owned by account",
- "name": "primarystoragetotal",
- "type": "long"
- },
- {
- "description": "the total number of public ip addresses available for this account to acquire",
- "name": "ipavailable",
+ "description": "the total number of cpu cores available to be created for this account",
+ "name": "cpuavailable",
"type": "string"
},
{
@@ -858,23 +814,19 @@
"type": "integer"
},
{
- "description": "the total number of templates which can be created by this account",
- "name": "templatelimit",
+ "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",
+ "description": "the name of the role",
+ "name": "rolename",
"type": "string"
},
+ {},
{
- "description": "the total number of network traffic bytes received",
- "name": "receivedbytes",
- "type": "long"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the total number of snapshots which can be stored by this account",
+ "name": "snapshotlimit",
"type": "string"
},
{
@@ -883,11 +835,146 @@
"type": "long"
},
{
+ "description": "the total number of projects the account can own",
+ "name": "projectlimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of virtual machines deployed by this account",
+ "name": "vmtotal",
+ "type": "long"
+ },
+ {
+ "description": "the total secondary storage space (in GiB) owned by account",
+ "name": "secondarystoragetotal",
+ "type": "float"
+ },
+ {
+ "description": "the state of the account",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "the total number of projects available for administration by this account",
+ "name": "projectavailable",
+ "type": "string"
+ },
+ {
+ "description": "the network domain",
+ "name": "networkdomain",
+ "type": "string"
+ },
+ {
+ "description": "the total memory (in MB) the account can own",
+ "name": "memorylimit",
+ "type": "string"
+ },
+ {
"description": "the total number of snapshots available for this account",
"name": "snapshotavailable",
"type": "string"
},
{
+ "description": "the total number of cpu cores the account can own",
+ "name": "cpulimit",
+ "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 memory (in MB) owned by account",
+ "name": "memorytotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of public ip addresses this account can acquire",
+ "name": "iplimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of public ip addresses allocated for this account",
+ "name": "iptotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of network traffic bytes sent",
+ "name": "sentbytes",
+ "type": "long"
+ },
+ {
+ "description": "the total number of templates which can be created by this account",
+ "name": "templatelimit",
+ "type": "string"
+ },
+ {
+ "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)",
+ "name": "roletype",
+ "type": "string"
+ },
+ {
+ "description": "the total number of virtual machines that can be deployed by this account",
+ "name": "vmlimit",
+ "type": "string"
+ },
+ {
+ "description": "path of the Domain the account belongs to",
+ "name": "domainpath",
+ "type": "string"
+ },
+ {
+ "description": "true if account is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {
+ "description": "the id of the account",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the total number of networks the account can own",
+ "name": "networklimit",
+ "type": "string"
+ },
+ {
+ "description": "details for the account",
+ "name": "accountdetails",
+ "type": "map"
+ },
+ {
+ "description": "account type (admin, domain-admin, user)",
+ "name": "accounttype",
+ "type": "short"
+ },
+ {
+ "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 number of cpu cores owned by account",
+ "name": "cputotal",
+ "type": "long"
+ },
+ {
+ "description": "the total memory (in MB) available to be created for this account",
+ "name": "memoryavailable",
+ "type": "string"
+ },
+ {
"description": "the total number of snapshots stored by this account",
"name": "snapshottotal",
"type": "long"
@@ -898,8 +985,13 @@
"type": "long"
},
{
- "description": "the ID of the role",
- "name": "roleid",
+ "description": "the total number of vpcs available to be created for this account",
+ "name": "vpcavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total primary storage space (in GiB) available to be used for this account",
+ "name": "primarystorageavailable",
"type": "string"
},
{
@@ -908,101 +1000,9 @@
"type": "string"
},
{
- "description": "the total number of virtual machines available for this account to acquire",
- "name": "vmavailable",
- "type": "string"
- },
- {
- "description": "the total secondary storage space (in GiB) the account can own",
- "name": "secondarystoragelimit",
- "type": "string"
- },
- {
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
- },
- {
- "description": "account type (admin, domain-admin, user)",
- "name": "accounttype",
- "type": "short"
- },
- {
- "description": "the total number of public ip addresses allocated for this account",
- "name": "iptotal",
- "type": "long"
- },
- {
- "description": "the total number of snapshots which can be stored by this account",
- "name": "snapshotlimit",
- "type": "string"
- },
- {
"description": "the total number of templates available to be created by this account",
"name": "templateavailable",
"type": "string"
- },
- {
- "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",
- "type": "string"
- },
- {
- "description": "the total number of public ip addresses this account can acquire",
- "name": "iplimit",
- "type": "string"
- },
- {
- "description": "the total number of templates which have been created by this account",
- "name": "templatetotal",
- "type": "long"
- },
- {
- "description": "the total number of vpcs available to be created for this account",
- "name": "vpcavailable",
- "type": "string"
- },
- {
- "description": "the total number of cpu cores available to be created for this account",
- "name": "cpuavailable",
- "type": "string"
- },
- {
- "description": "the total number of networks available to be created for this account",
- "name": "networkavailable",
- "type": "string"
- },
- {
- "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": "true if the account requires cleanup",
- "name": "iscleanuprequired",
- "type": "boolean"
- },
- {},
- {
- "description": "id of the Domain the account belongs to",
- "name": "domainid",
- "type": "string"
- },
- {},
- {
- "description": "the default zone of the account",
- "name": "defaultzoneid",
- "type": "string"
}
],
"since": "4.2.0"
@@ -1023,11 +1023,10 @@
"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",
@@ -1038,10 +1037,11 @@
"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.6.0"
@@ -1087,6 +1087,109 @@
"related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos",
"response": [
{
+ "description": "the template name",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "checksum of the template",
+ "name": "checksum",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the template",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "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 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 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": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "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 URL which the template/iso is registered from",
+ "name": "url",
+ "type": "string"
+ },
+ {
"description": "true if the entity/resource has annotations",
"name": "hasannotations",
"type": "boolean"
@@ -1097,187 +1200,8 @@
"type": "long"
},
{
- "description": "the date this template was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the list of resource tags associated",
- "name": "tags",
- "response": [
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the name of the 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": "checksum of the template",
- "name": "checksum",
- "type": "string"
- },
- {
- "description": "the status of the template",
- "name": "status",
- "type": "string"
- },
- {
- "description": "the format of the template.",
- "name": "format",
- "type": "imageformat"
- },
- {
- "description": "the tag of this template",
- "name": "templatetag",
- "type": "string"
- },
- {},
- {
- "description": "the project id of the template",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the type of the template",
- "name": "templatetype",
- "type": "string"
- },
- {
- "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.",
- "name": "deployasis",
- "type": "boolean"
- },
- {
- "description": "if Datadisk template, then id of the root disk template this template belongs to",
- "name": "parenttemplateid",
- "type": "string"
- },
- {
- "description": "true if the template is managed across all Zones, false otherwise",
- "name": "crossZones",
- "type": "boolean"
- },
- {
- "description": "true if the template is extractable, false otherwise",
- "name": "isextractable",
- "type": "boolean"
- },
- {},
- {
- "description": "the account id to which the template belongs",
- "name": "accountid",
- "type": "string"
- },
- {
- "description": "true if the template is ready to be deployed from, false otherwise.",
- "name": "isready",
- "type": "boolean"
- },
- {
- "description": "Lists the download progress of a template across all secondary storages",
- "name": "downloaddetails",
- "type": "list"
- },
- {
- "description": "the ID of the domain to which the template belongs",
- "name": "domainid",
- "type": "string"
- },
- {
- "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": "true if template is sshkey enabled, false otherwise",
- "name": "sshkeyenabled",
- "type": "boolean"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the template name",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the template ID",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the template display text",
- "name": "displaytext",
- "type": "string"
- },
- {
- "description": "the template ID of the parent template if present",
- "name": "sourcetemplateid",
+ "description": "the ID of the OS type for this template.",
+ "name": "ostypeid",
"type": "string"
},
{
@@ -1286,51 +1210,46 @@
"type": "boolean"
},
{
+ "description": "the tag of this template",
+ "name": "templatetag",
+ "type": "string"
+ },
+ {
"description": "the account name to which the template belongs",
"name": "account",
"type": "string"
},
{
- "description": "additional key/value details tied with template",
- "name": "details",
+ "description": "true if the template is extractable, false otherwise",
+ "name": "isextractable",
+ "type": "boolean"
+ },
+ {
+ "description": "true if template is sshkey enabled, false otherwise",
+ "name": "sshkeyenabled",
+ "type": "boolean"
+ },
+ {
+ "description": "the account id to which the template belongs",
+ "name": "accountid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the zone for this template",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "if Datadisk template, then id of the root disk template this template belongs to",
+ "name": "parenttemplateid",
+ "type": "string"
+ },
+ {
+ "description": "VMware only: additional key/value details tied with deploy-as-is template",
+ "name": "deployasisdetails",
"type": "map"
},
{
- "description": "true if the reset password feature is enabled, false otherwise",
- "name": "passwordenabled",
- "type": "boolean"
- },
- {
- "description": "the 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": "the name of the domain to which the template belongs",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the hypervisor on which the template runs",
- "name": "hypervisor",
- "type": "string"
- },
- {
- "description": "true if template requires HVM enabled, false otherwise",
- "name": "requireshvm",
- "type": "boolean"
- },
- {
- "description": "the date this template was removed",
- "name": "removed",
- "type": "date"
- },
- {
"description": "the processor bit size",
"name": "bits",
"type": "int"
@@ -1341,39 +1260,60 @@
"type": "string"
},
{
- "description": "the ID of the OS type for this template.",
- "name": "ostypeid",
+ "description": "the status of the template",
+ "name": "status",
"type": "string"
},
{
- "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory",
- "name": "isdynamicallyscalable",
+ "description": "the template ID",
+ "name": "id",
+ "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 type of the template",
+ "name": "templatetype",
+ "type": "string"
+ },
+ {
+ "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": "the project name of the template",
- "name": "project",
+ "description": "the template ID of the parent template if present",
+ "name": "sourcetemplateid",
"type": "string"
},
{
- "description": "VMware only: additional key/value details tied with deploy-as-is template",
- "name": "deployasisdetails",
- "type": "map"
+ "description": "the format of the template.",
+ "name": "format",
+ "type": "imageformat"
},
{
- "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": "if root disk template, then ids of the datas disk templates this template owns",
- "name": "childtemplates",
- "type": "set"
+ "description": "the physical size of the template",
+ "name": "physicalsize",
+ "type": "long"
},
{
"description": "the ID of the secondary storage host for the template",
@@ -1381,14 +1321,74 @@
"type": "string"
},
{
- "description": "the name of the zone for this template",
- "name": "zonename",
+ "description": "the date this template was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the project id of the template",
+ "name": "projectid",
"type": "string"
},
{
- "description": "the URL which the template/iso is registered from",
- "name": "url",
+ "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.",
+ "name": "deployasis",
+ "type": "boolean"
+ },
+ {
+ "description": "true if this template is a featured template, false otherwise",
+ "name": "isfeatured",
+ "type": "boolean"
+ },
+ {
+ "description": "Lists the download progress of a template across all secondary storages",
+ "name": "downloaddetails",
+ "type": "list"
+ },
+ {
+ "description": "the date this template was removed",
+ "name": "removed",
+ "type": "date"
+ },
+ {
+ "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage",
+ "name": "directdownload",
+ "type": "boolean"
+ },
+ {
+ "description": "the template display text",
+ "name": "displaytext",
"type": "string"
+ },
+ {
+ "description": "the name of the domain to which the template belongs",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "true if the template is managed across all Zones, false otherwise",
+ "name": "crossZones",
+ "type": "boolean"
+ },
+ {
+ "description": "the name of the OS type for this template.",
+ "name": "ostypename",
+ "type": "string"
+ },
+ {
+ "description": "additional key/value details tied with template",
+ "name": "details",
+ "type": "map"
+ },
+ {
+ "description": "true if the template is ready to be deployed from, false otherwise.",
+ "name": "isready",
+ "type": "boolean"
+ },
+ {
+ "description": "true if the reset password feature is enabled, false otherwise",
+ "name": "passwordenabled",
+ "type": "boolean"
}
]
},
@@ -1408,27 +1408,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": "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"
- },
- {}
+ }
]
},
{
@@ -1437,13 +1437,6 @@
"name": "provisionCertificate",
"params": [
{
- "description": "Whether to attempt reconnection with host/agent after successful deployment of certificate. When option is not provided, configured global setting is used",
- "length": 255,
- "name": "reconnect",
- "required": false,
- "type": "boolean"
- },
- {
"description": "The host/agent uuid to which the certificate has to be provisioned (issued and propagated)",
"length": 255,
"name": "hostid",
@@ -1452,6 +1445,13 @@
"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,
+ "name": "reconnect",
+ "required": false,
+ "type": "boolean"
+ },
+ {
"description": "Name of the CA service provider, otherwise the default configured provider plugin will be used",
"length": 255,
"name": "provider",
@@ -1460,17 +1460,15 @@
}
],
"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",
@@ -1478,10 +1476,12 @@
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- }
+ "description": "any text associated with the success or failure",
+ "name": "displaytext",
+ "type": "string"
+ },
+ {},
+ {}
],
"since": "4.11.0"
},
@@ -1491,13 +1491,6 @@
"name": "addExternalFirewall",
"params": [
{
- "description": "Password of the external firewall appliance.",
- "length": 255,
- "name": "password",
- "required": true,
- "type": "string"
- },
- {
"description": "Username of the external firewall appliance.",
"length": 255,
"name": "username",
@@ -1518,13 +1511,35 @@
"name": "url",
"required": true,
"type": "string"
+ },
+ {
+ "description": "Password of the external firewall appliance.",
+ "length": 255,
+ "name": "password",
+ "required": true,
+ "type": "string"
}
],
"related": "listExternalFirewalls",
"response": [
{
- "description": "the usage interface of the external firewall",
- "name": "usageinterface",
+ "description": "the public interface of the external firewall",
+ "name": "publicinterface",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the external firewall",
+ "name": "id",
"type": "string"
},
{
@@ -1538,40 +1553,18 @@
"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": "the number of times to retry requests to the external firewall",
- "name": "numretries",
- "type": "string"
- },
- {},
- {
"description": "the ID of the network device",
"name": "id",
"type": "string"
},
- {},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the public interface of the external firewall",
- "name": "publicinterface",
- "type": "string"
- },
- {
- "description": "the management IP address of the external firewall",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "description": "the private security zone of the external firewall",
- "name": "privatezone",
+ "description": "the usage interface of the external firewall",
+ "name": "usageinterface",
"type": "string"
},
{
@@ -1580,20 +1573,27 @@
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the ID of the external firewall",
- "name": "id",
+ "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 management IP address of the external firewall",
+ "name": "ipaddress",
"type": "string"
- }
+ },
+ {
+ "description": "the public security zone of the external firewall",
+ "name": "publiczone",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the private security zone of the external firewall",
+ "name": "privatezone",
+ "type": "string"
+ },
+ {}
]
},
{
@@ -1641,20 +1641,34 @@
"name": "listVirtualMachinesMetrics",
"params": [
{
- "description": "list vms by vpc",
+ "description": "list vms by iso",
"length": 255,
- "name": "vpcid",
- "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC",
+ "name": "isoid",
"required": false,
"type": "uuid"
},
{
- "description": "list only resources belonging to the domain specified",
+ "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
"length": 255,
- "name": "domainid",
- "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
+ "name": "isrecursive",
"required": false,
- "type": "uuid"
+ "type": "boolean"
+ },
+ {
+ "description": "the IDs of the virtual machines, mutually exclusive with id",
+ "length": 255,
+ "name": "ids",
+ "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,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",
+ "required": false,
+ "since": "4.4",
+ "type": "list"
+ },
+ {
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
},
{
"description": "list resources by display flag; only ROOT admin is eligible to pass this parameter",
@@ -1665,38 +1679,68 @@
"type": "boolean"
},
{
- "description": "the pod ID",
+ "description": "flag to display the resource icon for VMs",
"length": 255,
- "name": "podid",
- "related": "listPods,updatePod,createManagementNetworkIpRange",
+ "name": "showicon",
+ "required": false,
+ "since": "4.16.0.0",
+ "type": "boolean"
+ },
+ {
+ "description": "list by the service offering",
+ "length": 255,
+ "name": "serviceofferingid",
+ "related": "createServiceOffering,updateServiceOffering,listServiceOfferings",
+ "required": false,
+ "since": "4.4",
+ "type": "uuid"
+ },
+ {
+ "description": "list vms by vpc",
+ "length": 255,
+ "name": "vpcid",
+ "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC",
"required": false,
"type": "uuid"
},
{
- "description": "the security group ID",
+ "description": "name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned)",
"length": 255,
- "name": "securitygroupid",
- "related": "createSecurityGroup,listSecurityGroups,updateSecurityGroup",
- "required": false,
- "since": "4.15",
- "type": "uuid"
- },
- {
- "description": "the storage ID where vm's volumes belong to",
- "length": 255,
- "name": "storageid",
- "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities,listVsphereStoragePolicyCompatiblePools",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
+ "name": "name",
"required": false,
"type": "string"
},
{
+ "description": "List resources by tags (key/value pairs)",
+ "length": 255,
+ "name": "tags",
+ "required": false,
+ "type": "map"
+ },
+ {
+ "description": "list by network id",
+ "length": 255,
+ "name": "networkid",
+ "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "list vms by affinity group",
+ "length": 255,
+ "name": "affinitygroupid",
+ "related": "createAffinityGroup,listAffinityGroups",
+ "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",
+ "length": 255,
+ "name": "listall",
+ "required": false,
+ "type": "boolean"
+ },
+ {
"description": "the group ID",
"length": 255,
"name": "groupid",
@@ -1705,6 +1749,51 @@
"type": "uuid"
},
{
+ "description": "the target hypervisor for the template",
+ "length": 255,
+ "name": "hypervisor",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "list objects by project",
+ "length": 255,
+ "name": "projectid",
+ "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject",
+ "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": "state",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the storage ID where vm's volumes belong to",
+ "length": 255,
+ "name": "storageid",
+ "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities,listVsphereStoragePolicyCompatiblePools",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "list by network type; true if need to list vms using Virtual Network, false otherwise",
+ "length": 255,
+ "name": "forvirtualnetwork",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "list only resources belonging to the domain specified",
+ "length": 255,
+ "name": "domainid",
+ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
+ "required": false,
+ "type": "uuid"
+ },
+ {
"description": "list vms by ssh keypair name",
"length": 255,
"name": "keypair",
@@ -1712,6 +1801,13 @@
"type": "string"
},
{
+ "description": "list resources by account. Must be used with the domainId parameter.",
+ "length": 255,
+ "name": "account",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "the availability zone ID",
"length": 255,
"name": "zoneid",
@@ -1728,11 +1824,28 @@
"type": "uuid"
},
{
- "description": "comma separated list of host details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, iso, volume, min, affgrp]. If no parameter is passed in, the details will be defaulted to all",
+ "description": "",
"length": 255,
- "name": "details",
+ "name": "page",
"required": false,
- "type": "list"
+ "type": "integer"
+ },
+ {
+ "description": "the security group ID",
+ "length": 255,
+ "name": "securitygroupid",
+ "related": "createSecurityGroup,listSecurityGroups,updateSecurityGroup",
+ "required": false,
+ "since": "4.15",
+ "type": "uuid"
+ },
+ {
+ "description": "the ID of the virtual machine",
+ "length": 255,
+ "name": "id",
+ "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,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",
+ "required": false,
+ "type": "uuid"
},
{
"description": "",
@@ -1742,41 +1855,25 @@
"type": "integer"
},
{
- "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 host ID",
"length": 255,
- "name": "name",
- "required": false,
- "type": "string"
- },
- {
- "description": "the IDs of the virtual machines, mutually exclusive with id",
- "length": 255,
- "name": "ids",
- "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,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",
- "required": false,
- "since": "4.4",
- "type": "list"
- },
- {
- "description": "the target hypervisor for the template",
- "length": 255,
- "name": "hypervisor",
- "required": false,
- "type": "string"
- },
- {
- "description": "list objects by project",
- "length": 255,
- "name": "projectid",
- "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject",
+ "name": "hostid",
+ "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost,listExternalLoadBalancers",
"required": false,
"type": "uuid"
},
{
- "description": "list vms by affinity group",
+ "description": "comma separated list of host details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, iso, volume, min, affgrp]. If no parameter is passed in, the details will be defaulted to all",
"length": 255,
- "name": "affinitygroupid",
- "related": "createAffinityGroup,listAffinityGroups",
+ "name": "details",
+ "required": false,
+ "type": "list"
+ },
+ {
+ "description": "the pod ID",
+ "length": 255,
+ "name": "podid",
+ "related": "listPods,updatePod,createManagementNetworkIpRange",
"required": false,
"type": "uuid"
},
@@ -1789,166 +1886,19 @@
"type": "boolean"
},
{
- "description": "List resources by tags (key/value pairs)",
- "length": 255,
- "name": "tags",
- "required": false,
- "type": "map"
- },
- {
- "description": "the host ID",
- "length": 255,
- "name": "hostid",
- "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost,listExternalLoadBalancers",
- "required": false,
- "type": "uuid"
- },
- {
- "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": "state",
- "required": false,
- "type": "string"
- },
- {
"description": "the user ID that created the VM and is under the account that owns the VM",
"length": 255,
"name": "userid",
"related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser",
"required": false,
"type": "uuid"
- },
- {
- "description": "",
- "length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
- },
- {
- "description": "flag to display the resource icon for VMs",
- "length": 255,
- "name": "showicon",
- "required": false,
- "since": "4.16.0.0",
- "type": "boolean"
- },
- {
- "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false",
- "length": 255,
- "name": "listall",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "list resources by account. Must be used with the domainId parameter.",
- "length": 255,
- "name": "account",
- "required": false,
- "type": "string"
- },
- {
- "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
- "length": 255,
- "name": "isrecursive",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "list by network id",
- "length": 255,
- "name": "networkid",
- "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "list by the service offering",
- "length": 255,
- "name": "serviceofferingid",
- "related": "createServiceOffering,updateServiceOffering,listServiceOfferings",
- "required": false,
- "since": "4.4",
- "type": "uuid"
- },
- {
- "description": "list by network type; true if need to list vms using Virtual Network, false otherwise",
- "length": 255,
- "name": "forvirtualnetwork",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "the ID of the virtual machine",
- "length": 255,
- "name": "id",
- "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,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",
- "required": false,
- "type": "uuid"
}
],
"related": "",
"response": [
{
- "description": "the 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 pool type of the virtual machine",
- "name": "pooltype",
- "type": "string"
- },
- {
- "description": "the hypervisor on which the template runs",
- "name": "hypervisor",
- "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": "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 created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the name of the virtual machine",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the read (io) of disk on the vm",
- "name": "diskioread",
- "type": "long"
- },
- {
- "description": "ssh key-pair",
- "name": "keypair",
- "type": "string"
- },
- {
- "description": "the ID of the availablility zone for the virtual machine",
- "name": "zoneid",
+ "description": "the password (if exists) of the virtual machine",
+ "name": "password",
"type": "string"
},
{
@@ -1957,49 +1907,185 @@
"type": "string"
},
{
- "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": "disk write in MiB",
+ "name": "diskwrite",
"type": "string"
},
{
- "description": "the user's ID who deployed the virtual machine",
- "name": "userid",
+ "description": "the VM's primary IP address",
+ "name": "ipaddress",
"type": "string"
},
{
- "description": "the total cpu capacity in Ghz",
- "name": "cputotal",
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the internal memory that's free in vm or zero if it can not be calculated",
+ "name": "memoryintfreekbs",
+ "type": "long"
+ },
+ {
+ "description": "the list of nics associated with vm",
+ "name": "nic",
+ "response": [
+ {
+ "description": "the name of the corresponding network",
+ "name": "networkname",
+ "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 type of the nic",
+ "name": "type",
+ "type": "string"
+ },
+ {
+ "description": "the broadcast uri of the nic",
+ "name": "broadcasturi",
+ "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": "the netmask of the nic",
+ "name": "netmask",
+ "type": "string"
+ },
+ {
+ "description": "the cidr of IPv6 network",
+ "name": "ip6cidr",
+ "type": "string"
+ },
+ {
+ "description": "Type of adapter if available",
+ "name": "adaptertype",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the corresponding network",
+ "name": "networkid",
+ "type": "string"
+ },
+ {
+ "description": "the IPv6 address of network",
+ "name": "ip6address",
+ "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": "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",
+ "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 isolated private VLAN if available",
+ "name": "isolatedpvlan",
+ "type": "integer"
+ },
+ {
+ "description": "ID of the VLAN/VNI if available",
+ "name": "vlanid",
+ "type": "integer"
+ },
+ {
+ "description": "the isolated private VLAN type if available",
+ "name": "isolatedpvlantype",
+ "type": "string"
+ },
+ {
+ "description": "Id of the vm to which the nic belongs",
+ "name": "virtualmachineid",
+ "type": "string"
+ },
+ {
+ "description": "the isolation uri of the nic",
+ "name": "isolationuri",
+ "type": "string"
+ },
+ {
+ "description": "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"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the name of the disk offering of the virtual machine",
+ "name": "diskofferingname",
"type": "string"
},
{
- "description": "device type of the root volume",
- "name": "rootdevicetype",
+ "description": "disk read in MiB",
+ "name": "diskread",
"type": "string"
},
{
- "description": "the project name of the vm",
- "name": "project",
+ "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 UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "Guest vm Boot Type",
- "name": "boottype",
- "type": "string"
- },
- {
- "description": "State of the Service from LB rule",
- "name": "servicestate",
+ "description": "the name of the virtual machine",
+ "name": "name",
"type": "string"
},
{
@@ -2008,171 +2094,34 @@
"type": "string"
},
{
- "description": "the password (if exists) of the virtual machine",
- "name": "password",
+ "description": "the ID of the host for the virtual machine",
+ "name": "hostid",
"type": "string"
},
{
- "description": "the ID of the backup offering of the virtual machine",
- "name": "backupofferingid",
+ "description": "public IP address id associated with vm via Static nat rule",
+ "name": "publicipid",
"type": "string"
},
{
- "description": " an alternate display text of the template for the virtual machine",
- "name": "templatedisplaytext",
- "type": "string"
- },
- {
- "description": "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 speed of each cpu",
- "name": "cpuspeed",
- "type": "integer"
- },
- {
- "description": "the total disk iops",
- "name": "diskiopstotal",
+ "description": "the target memory in vm",
+ "name": "memorytargetkbs",
"type": "long"
},
{
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "true if high-availability is enabled, false otherwise",
- "name": "haenable",
- "type": "boolean"
- },
- {
- "description": "the total memory capacity in GiB",
- "name": "memorytotal",
+ "description": "the group name of the virtual machine",
+ "name": "group",
"type": "string"
},
{
- "description": "the total number of network traffic bytes sent",
- "name": "sentbytes",
+ "description": "the read (bytes) of disk on the vm",
+ "name": "diskkbsread",
"type": "long"
},
{
- "description": "Guest vm Boot Mode",
- "name": "bootmode",
- "type": "string"
- },
- {
- "description": "the ID of the disk offering of the virtual machine",
- "name": "diskofferingid",
- "type": "string"
- },
- {
- "description": "OS name of the vm",
- "name": "osdisplayname",
- "type": "string"
- },
- {
- "description": "network write in MiB",
- "name": "networkwrite",
- "type": "string"
- },
- {
- "description": "the account associated with the virtual machine",
- "name": "account",
- "type": "string"
- },
- {
- "description": "true if the password rest feature is enabled, false otherwise",
- "name": "passwordenabled",
- "type": "boolean"
- },
- {
- "description": "the VM's primary IP address",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "description": "the number of cpu this virtual machine is running with",
- "name": "cpunumber",
- "type": "integer"
- },
- {
- "description": "the name of the availability zone for the virtual machine",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "network read in MiB",
- "name": "networkread",
- "type": "string"
- },
- {
- "description": "the list of resource tags associated",
- "name": "tags",
- "response": [
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "the 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 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": "resource type",
- "name": "resourcetype",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "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": "user generated name. The name of the virtual machine is returned if no displayname exists.",
@@ -2185,181 +2134,23 @@
"type": "resourceiconresponse"
},
{
+ "description": "OS name of the vm",
+ "name": "osdisplayname",
+ "type": "string"
+ },
+ {
"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 UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
- "description": "the virtual network for the service offering",
- "name": "forvirtualnetwork",
- "type": "boolean"
- },
- {
- "description": "the memory allocated for the virtual machine",
- "name": "memory",
- "type": "integer"
- },
- {
- "description": "the list of nics associated with vm",
- "name": "nic",
- "response": [
- {
- "description": "the Secondary ipv4 addr of nic",
- "name": "secondaryip",
- "type": "list"
- },
- {
- "description": "the isolation uri of the nic",
- "name": "isolationuri",
- "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 name of the corresponding network",
- "name": "networkname",
- "type": "string"
- },
- {
- "description": "the type of the nic",
- "name": "type",
- "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": "the gateway of the nic",
- "name": "gateway",
- "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": "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 netmask of the nic",
- "name": "netmask",
- "type": "string"
- },
- {
- "description": "Type of adapter if available",
- "name": "adaptertype",
- "type": "string"
- },
- {
- "description": "true if nic is default, false otherwise",
- "name": "macaddress",
- "type": "string"
- },
- {
- "description": "the extra dhcp options on the nic",
- "name": "extradhcpoption",
- "type": "list"
- },
- {
- "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",
- "type": "string"
- },
- {
- "description": "the IPv6 address of network",
- "name": "ip6address",
- "type": "string"
- },
- {
- "description": "the cidr of IPv6 network",
- "name": "ip6cidr",
- "type": "string"
- },
- {
- "description": "device id for the network when plugged into the virtual machine",
- "name": "deviceid",
- "type": "string"
- },
- {
- "description": "the ID of the nic",
- "name": "id",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the name of the domain in which the virtual machine exists",
- "name": "domain",
- "type": "string"
- },
- {},
- {
- "description": "the outgoing network traffic on the host",
- "name": "networkkbswrite",
- "type": "long"
- },
- {
- "description": "the name of the disk offering of the virtual machine",
- "name": "diskofferingname",
- "type": "string"
- },
- {
- "description": "the state of the virtual machine",
- "name": "state",
+ "description": "network read in MiB",
+ "name": "networkread",
"type": "string"
},
{
@@ -2368,33 +2159,24 @@
"type": "string"
},
{
- "description": "disk read in MiB",
- "name": "diskread",
+ "description": "the memory used by the vm",
+ "name": "memorykbs",
+ "type": "long"
+ },
+ {},
+ {
+ "description": "the pool type of the virtual machine",
+ "name": "pooltype",
"type": "string"
},
{
- "description": "disk write in MiB",
- "name": "diskwrite",
+ "description": " an alternate display text of the template for the virtual machine",
+ "name": "templatedisplaytext",
"type": "string"
},
{
- "description": "the user's name who deployed the virtual machine",
- "name": "username",
- "type": "string"
- },
- {
- "description": "the name of the template for the virtual machine",
- "name": "templatename",
- "type": "string"
- },
- {
- "description": "public IP address id associated with vm via Static nat rule",
- "name": "publicipid",
- "type": "string"
- },
- {
- "description": "the name of the service offering of the virtual machine",
- "name": "serviceofferingname",
+ "description": "the group ID of the virtual machine",
+ "name": "groupid",
"type": "string"
},
{
@@ -2403,95 +2185,13 @@
"type": "string"
},
{
- "description": "the read (bytes) of disk on the vm",
- "name": "diskkbsread",
- "type": "long"
- },
- {
- "description": "the memory used by the vm",
- "name": "memorykbs",
- "type": "long"
- },
- {
- "description": "the group ID of the virtual machine",
- "name": "groupid",
+ "description": "OS type id of the vm",
+ "name": "ostypeid",
"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 name of the affinity group",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the account owning the affinity group",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the domain ID of the affinity group",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the project name of the affinity group",
- "name": "project",
- "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 domain name of the affinity group",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the project ID of the affinity group",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the type of the affinity group",
- "name": "type",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the internal memory that's free in vm or zero if it can not be calculated",
- "name": "memoryintfreekbs",
- "type": "long"
- },
- {
- "description": "the total number of network traffic bytes received",
- "name": "receivedbytes",
- "type": "long"
- },
- {
- "description": "the ID of the ISO attached to the virtual machine",
- "name": "isoid",
+ "description": "network write in MiB",
+ "name": "networkwrite",
"type": "string"
},
{
@@ -2500,134 +2200,95 @@
"type": "string"
},
{
+ "description": "List of read-only Vm details as comma separated string.",
+ "name": "readonlydetails",
+ "type": "string"
+ },
+ {
+ "description": "an optional field whether to the display the vm to the end user or not.",
+ "name": "displayvm",
+ "type": "boolean"
+ },
+ {
+ "description": "the read (io) of disk on the vm",
+ "name": "diskioread",
+ "type": "long"
+ },
+ {
+ "description": "the name of the host for the virtual machine",
+ "name": "hostname",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the service offering of the virtual machine",
+ "name": "serviceofferingid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the template for the virtual machine",
+ "name": "templatename",
+ "type": "string"
+ },
+ {
+ "description": "the incoming network traffic on the vm",
+ "name": "networkkbsread",
+ "type": "long"
+ },
+ {
"description": "device ID of the root volume",
"name": "rootdeviceid",
"type": "long"
},
{
- "description": "the target memory in vm",
- "name": "memorytargetkbs",
+ "description": "Guest vm Boot Mode",
+ "name": "bootmode",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the ISO attached to the virtual machine",
+ "name": "isoid",
+ "type": "string"
+ },
+ {
+ "description": "State of the Service from LB rule",
+ "name": "servicestate",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the disk offering of the virtual machine",
+ "name": "diskofferingid",
+ "type": "string"
+ },
+ {
+ "description": "the user's name who deployed the virtual machine",
+ "name": "username",
+ "type": "string"
+ },
+ {
+ "description": "the outgoing network traffic on the host",
+ "name": "networkkbswrite",
"type": "long"
},
{
+ "description": "Os type ID of the virtual machine",
+ "name": "guestosid",
+ "type": "string"
+ },
+ {
+ "description": "an alternate display text of the ISO attached to the virtual machine",
+ "name": "isodisplaytext",
+ "type": "string"
+ },
+ {
"description": "list of security groups associated with the virtual machine",
"name": "securitygroup",
"response": [
{
- "description": "the name of the security group",
- "name": "name",
+ "description": "the project id of the group",
+ "name": "projectid",
"type": "string"
},
{
- "description": "the list of egress rules associated with the security group",
- "name": "egressrule",
- "response": [
- {
- "description": "the list of resource tags associated with the rule",
- "name": "tags",
- "response": [
- {
- "description": "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": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- }
- ],
- "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 code for the ICMP message response",
- "name": "icmpcode",
- "type": "integer"
- },
- {
- "description": "the CIDR notation for the base IP address of the security group rule",
- "name": "cidr",
- "type": "string"
- },
- {
- "description": "security group name",
- "name": "securitygroupname",
- "type": "string"
- },
- {
- "description": "the ending IP of the security group rule ",
- "name": "endport",
- "type": "integer"
- },
- {
- "description": "the starting IP of the security group rule",
- "name": "startport",
- "type": "integer"
- },
- {
- "description": "account owning the security group rule",
- "name": "account",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
"description": "the description of the security group",
"name": "description",
"type": "string"
@@ -2642,6 +2303,11 @@
"type": "string"
},
{
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
"description": "the project id the tag belongs to",
"name": "projectid",
"type": "string"
@@ -2652,8 +2318,8 @@
"type": "string"
},
{
- "description": "tag key name",
- "name": "key",
+ "description": "the account associated with the tag",
+ "name": "account",
"type": "string"
},
{
@@ -2662,8 +2328,8 @@
"type": "string"
},
{
- "description": "id of the resource",
- "name": "resourceid",
+ "description": "customer associated with the tag",
+ "name": "customer",
"type": "string"
},
{
@@ -2672,13 +2338,8 @@
"type": "string"
},
{
- "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"
},
{
@@ -2690,52 +2351,12 @@
"type": "set"
},
{
- "description": "the domain name of the security group",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the number of virtualmachines associated with this securitygroup",
- "name": "virtualmachinecount",
- "type": "integer"
- },
- {
- "description": "the project name of the group",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the project id of the group",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the account owning the security group",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the domain ID of the security group",
- "name": "domainid",
- "type": "string"
- },
- {
"description": "the list of ingress rules associated with the security group",
"name": "ingressrule",
"response": [
{
- "description": "the protocol of the security group rule",
- "name": "protocol",
- "type": "string"
- },
- {
- "description": "the 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"
},
{
@@ -2754,52 +2375,57 @@
"type": "string"
},
{
- "description": "the starting IP of the security group rule",
- "name": "startport",
+ "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": "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 list of resource tags associated with the rule",
"name": "tags",
"response": [
{
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
"description": "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": "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",
+ "description": "resource type",
+ "name": "resourcetype",
"type": "string"
},
{
@@ -2808,6 +2434,16 @@
"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"
@@ -2819,11 +2455,6 @@
}
],
"type": "set"
- },
- {
- "description": "the ending IP of the security group rule ",
- "name": "endport",
- "type": "integer"
}
],
"type": "set"
@@ -2834,48 +2465,236 @@
"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 name of the security group",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the account owning the security group",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID of the security group",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the 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 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": "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": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "security group name",
+ "name": "securitygroupname",
+ "type": "string"
+ },
+ {
+ "description": "account owning the security group rule",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the type of the ICMP message response",
+ "name": "icmptype",
+ "type": "integer"
+ },
+ {
+ "description": "the code for the ICMP message response",
+ "name": "icmpcode",
+ "type": "integer"
+ },
+ {
+ "description": "the id of the security group rule",
+ "name": "ruleid",
+ "type": "string"
+ },
+ {
+ "description": "the CIDR notation for the base IP address of the security group rule",
+ "name": "cidr",
+ "type": "string"
+ },
+ {
+ "description": "the protocol of the security group rule",
+ "name": "protocol",
+ "type": "string"
+ },
+ {
+ "description": "the ending IP of the security group rule ",
+ "name": "endport",
+ "type": "integer"
+ }
+ ],
+ "type": "set"
}
],
"type": "set"
},
- {},
{
- "description": "an alternate display text of the ISO attached to the virtual machine",
- "name": "isodisplaytext",
+ "description": "ssh key-pair",
+ "name": "keypair",
"type": "string"
},
{
- "description": "the ID of the virtual machine",
- "name": "id",
+ "description": "the account associated with the virtual machine",
+ "name": "account",
"type": "string"
},
{
- "description": "the ID of the host for the virtual machine",
- "name": "hostid",
- "type": "string"
- },
- {
- "description": "the group name of the virtual machine",
- "name": "group",
- "type": "string"
- },
- {
- "description": "an optional field whether to the display the vm to the end user or not.",
- "name": "displayvm",
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
"type": "boolean"
},
{
- "description": "the incoming network traffic on the vm",
- "name": "networkkbsread",
+ "description": "the memory allocated for the virtual machine",
+ "name": "memory",
+ "type": "integer"
+ },
+ {
+ "description": "the total cpu capacity in Ghz",
+ "name": "cputotal",
+ "type": "string"
+ },
+ {
+ "description": "the state of the virtual machine",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the availablility zone for the virtual machine",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "true if high-availability is enabled, false otherwise",
+ "name": "haenable",
+ "type": "boolean"
+ },
+ {
+ "description": "Guest vm Boot Type",
+ "name": "boottype",
+ "type": "string"
+ },
+ {
+ "description": "the virtual network for the service offering",
+ "name": "forvirtualnetwork",
+ "type": "boolean"
+ },
+ {
+ "description": "device type of the root volume",
+ "name": "rootdevicetype",
+ "type": "string"
+ },
+ {
+ "description": "the total number of network traffic bytes sent",
+ "name": "sentbytes",
"type": "long"
},
{
- "description": "the write (bytes) of disk on the vm",
- "name": "diskkbswrite",
- "type": "long"
+ "description": "the amount of the vm's CPU currently used",
+ "name": "cpuused",
+ "type": "string"
+ },
+ {
+ "description": "instance name of the user vm; this parameter is returned to the ROOT admin only",
+ "name": "instancename",
+ "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": "true if the password rest feature is enabled, false otherwise",
+ "name": "passwordenabled",
+ "type": "boolean"
},
{
"description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.",
@@ -2883,8 +2702,189 @@
"type": "boolean"
},
{
- "description": "Os type ID of the virtual machine",
- "name": "guestosid",
+ "description": "the date when this virtual machine was updated last time",
+ "name": "lastupdated",
+ "type": "date"
+ },
+ {
+ "description": "the ID of the virtual machine",
+ "name": "id",
+ "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": "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": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the total memory capacity in GiB",
+ "name": "memorytotal",
+ "type": "string"
+ },
+ {
+ "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 speed of each cpu",
+ "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 write (bytes) of disk on the vm",
+ "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 total disk iops",
+ "name": "diskiopstotal",
+ "type": "long"
+ },
+ {
+ "description": "the write (io) of disk on the vm",
+ "name": "diskiowrite",
+ "type": "long"
+ },
+ {
+ "description": "list of affinity groups associated with the virtual machine",
+ "name": "affinitygroup",
+ "response": [
+ {
+ "description": "the account owning the affinity group",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "virtual machine IDs associated with this affinity group",
+ "name": "virtualmachineIds",
+ "type": "list"
+ },
+ {
+ "description": "the project ID of the affinity group",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "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": "the ID of the affinity group",
+ "name": "id",
+ "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 type of the affinity group",
+ "name": "type",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the number of cpu this virtual machine is running with",
+ "name": "cpunumber",
+ "type": "integer"
+ },
+ {
+ "description": "the name of the service offering of the virtual machine",
+ "name": "serviceofferingname",
"type": "string"
}
],
@@ -2896,28 +2896,6 @@
"name": "listHosts",
"params": [
{
- "description": "lists hosts existing in particular cluster",
- "length": 255,
- "name": "clusterid",
- "related": "addCluster,listClusters,updateCluster",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "list hosts for which out-of-band management is enabled",
- "length": 255,
- "name": "outofbandmanagementenabled",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "",
- "length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
- },
- {
"description": "comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]",
"length": 255,
"name": "details",
@@ -2925,13 +2903,6 @@
"type": "list"
},
{
- "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": "",
"length": 255,
"name": "pagesize",
@@ -2939,6 +2910,29 @@
"type": "integer"
},
{
+ "description": "the state of the host",
+ "length": 255,
+ "name": "state",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "lists hosts existing in particular cluster",
+ "length": 255,
+ "name": "clusterid",
+ "related": "addCluster,listClusters,updateCluster",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "the Pod ID for the host",
+ "length": 255,
+ "name": "podid",
+ "related": "listPods,updatePod,createManagementNetworkIpRange",
+ "required": false,
+ "type": "uuid"
+ },
+ {
"description": "the host type",
"length": 255,
"name": "type",
@@ -2946,6 +2940,41 @@
"type": "string"
},
{
+ "description": "the name of the host",
+ "length": 255,
+ "name": "name",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "list hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown]",
+ "length": 255,
+ "name": "outofbandmanagementpowerstate",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator",
+ "length": 255,
+ "name": "hypervisor",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "if true, list only hosts dedicated to HA",
+ "length": 255,
+ "name": "hahost",
+ "required": false,
+ "type": "boolean"
+ },
+ {
"description": "the id of the host",
"length": 255,
"name": "id",
@@ -2962,24 +2991,16 @@
"type": "uuid"
},
{
- "description": "the Pod ID for the host",
+ "description": "list hosts by resource state. Resource state represents current state determined by admin of host, value can be one of [Enabled, Disabled, Unmanaged, PrepareForMaintenance, ErrorInMaintenance, Maintenance, Error]",
"length": 255,
- "name": "podid",
- "related": "listPods,updatePod,createManagementNetworkIpRange",
+ "name": "resourcestate",
"required": false,
- "type": "uuid"
+ "type": "string"
},
{
- "description": "if true, list only hosts dedicated to HA",
+ "description": "List by keyword",
"length": 255,
- "name": "hahost",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "the state of the host",
- "length": 255,
- "name": "state",
+ "name": "keyword",
"required": false,
"type": "string"
},
@@ -2992,85 +3013,29 @@
"type": "uuid"
},
{
- "description": "list hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown]",
+ "description": "list hosts for which out-of-band management is enabled",
"length": 255,
- "name": "outofbandmanagementpowerstate",
+ "name": "outofbandmanagementenabled",
"required": false,
- "type": "string"
- },
- {
- "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator",
- "length": 255,
- "name": "hypervisor",
- "required": false,
- "type": "string"
- },
- {
- "description": "the name of the host",
- "length": 255,
- "name": "name",
- "required": false,
- "type": "string"
- },
- {
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
+ "type": "boolean"
}
],
"related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost,listExternalLoadBalancers",
"response": [
{
- "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise",
- "name": "hahost",
- "type": "boolean"
- },
- {
- "description": "the IP address of the host",
- "name": "ipaddress",
+ "description": "the amount of the host's memory after applying the mem.overprovisioning.factor",
+ "name": "memorywithoverprovisioning",
"type": "string"
},
{
- "description": "the CPU number of the host",
- "name": "cpunumber",
- "type": "integer"
- },
- {
- "description": "the host hypervisor",
- "name": "hypervisor",
- "type": "hypervisortype"
- },
- {
- "description": "true if the host is disconnected. False otherwise.",
- "name": "disconnected",
- "type": "date"
- },
- {
- "description": "the amount of the host's memory currently allocated in percentage",
- "name": "memoryallocatedpercentage",
+ "description": "capabilities of the host",
+ "name": "capabilities",
"type": "string"
},
{
- "description": "the amount of the host's CPU currently allocated",
- "name": "cpuallocated",
- "type": "string"
- },
- {
- "description": "the Zone ID of the host",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the date and time the host was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the number of CPU sockets on the host",
- "name": "cpusockets",
- "type": "integer"
+ "description": "the amount of the host's memory currently allocated in bytes",
+ "name": "memoryallocatedbytes",
+ "type": "long"
},
{
"description": "the Pod name of the host",
@@ -3078,53 +3043,23 @@
"type": "string"
},
{
- "description": "the hypervisor version",
- "name": "hypervisorversion",
+ "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": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise",
+ "name": "suitableformigration",
+ "type": "boolean"
},
{
- "description": "the resource state of the host",
- "name": "resourcestate",
+ "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor",
+ "name": "cpuallocatedwithoverprovisioning",
"type": "string"
},
{
- "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor",
- "name": "cpuwithoverprovisioning",
- "type": "string"
- },
- {
- "description": "the name of the host",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the host type",
- "name": "type",
- "type": "type"
- },
- {
- "description": "the amount of the host's CPU currently allocated in MHz",
- "name": "cpuallocatedvalue",
- "type": "long"
- },
- {
- "description": "the host version",
- "name": "version",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "events available for the host",
- "name": "events",
+ "description": "the cluster type of the cluster that host belongs to",
+ "name": "clustertype",
"type": "string"
},
{
@@ -3133,18 +3068,159 @@
"type": "long"
},
{
+ "description": "the host's currently allocated disk size",
+ "name": "disksizeallocated",
+ "type": "long"
+ },
+ {
+ "description": "the host version",
+ "name": "version",
+ "type": "string"
+ },
+ {
+ "description": "true if local storage is active, false otherwise",
+ "name": "islocalstorageactive",
+ "type": "boolean"
+ },
+ {
+ "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise",
+ "name": "hasenoughcapacity",
+ "type": "boolean"
+ },
+ {
+ "description": "the state of the host",
+ "name": "state",
+ "type": "status"
+ },
+ {
+ "description": "the 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",
+ "name": "cpuallocated",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the host's CPU currently allocated in MHz",
+ "name": "cpuallocatedvalue",
+ "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 OS category name of the host",
+ "name": "oscategoryname",
+ "type": "string"
+ },
+ {
+ "description": "the OS category ID of the host",
+ "name": "oscategoryid",
+ "type": "string"
+ },
+ {
+ "description": "the CPU number of the host",
+ "name": "cpunumber",
+ "type": "integer"
+ },
+ {
+ "description": "events available for the host",
+ "name": "events",
+ "type": "string"
+ },
+ {
"description": "the admin that annotated this host",
"name": "username",
"type": "string"
},
{
- "description": "the Pod ID of the host",
- "name": "podid",
+ "description": "the amount of the host's CPU currently used",
+ "name": "cpuused",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the cluster name of the host",
+ "name": "clustername",
+ "type": "string"
+ },
+ {
+ "description": "the resource state of the host",
+ "name": "resourcestate",
+ "type": "string"
+ },
+ {
+ "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",
+ "type": "boolean"
+ },
+ {
+ "description": "the name of the host",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "true if the host is disconnected. False otherwise.",
+ "name": "disconnected",
+ "type": "date"
+ },
+ {
+ "description": "the hypervisor version",
+ "name": "hypervisorversion",
+ "type": "string"
+ },
+ {
+ "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 last time this host was annotated",
+ "name": "lastannotated",
+ "type": "date"
+ },
+ {
+ "description": "the amount of the host's CPU currently allocated in percentage",
+ "name": "cpuallocatedpercentage",
+ "type": "string"
+ },
+ {
+ "description": "the host type",
+ "name": "type",
+ "type": "type"
+ },
+ {
+ "description": "Host details in key/value pairs.",
+ "name": "details",
+ "type": "map"
+ },
+ {
+ "description": "the Zone name of the host",
+ "name": "zonename",
"type": "string"
},
{
@@ -3152,6 +3228,11 @@
"name": "gpugroup",
"response": [
{
+ "description": "GPU cards present in the host",
+ "name": "gpugroupname",
+ "type": "string"
+ },
+ {
"description": "the list of enabled vGPUs",
"name": "vgpu",
"response": [
@@ -3161,18 +3242,13 @@
"type": "long"
},
{
- "description": "Maximum X resolution per display",
- "name": "maxresolutionx",
- "type": "long"
- },
- {
"description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type",
"name": "remainingcapacity",
"type": "long"
},
{
- "description": "Maximum no. of vgpu per gpu card (pgpu)",
- "name": "maxvgpuperpgpu",
+ "description": "Maximum Y resolution per display",
+ "name": "maxresolutiony",
"type": "long"
},
{
@@ -3186,156 +3262,35 @@
"type": "long"
},
{
- "description": "Maximum vgpu can be created with this vgpu type on the given gpu group",
- "name": "maxcapacity",
+ "description": "Maximum X resolution per display",
+ "name": "maxresolutionx",
"type": "long"
},
{
- "description": "Maximum Y resolution per display",
- "name": "maxresolutiony",
+ "description": "Maximum no. of vgpu per gpu card (pgpu)",
+ "name": "maxvgpuperpgpu",
+ "type": "long"
+ },
+ {
+ "description": "Maximum vgpu can be created with this vgpu type on the given gpu group",
+ "name": "maxcapacity",
"type": "long"
}
],
"type": "list"
- },
- {
- "description": "GPU cards present in the host",
- "name": "gpugroupname",
- "type": "string"
}
],
"type": "list"
},
{
- "description": "the OS category name of the host",
- "name": "oscategoryname",
+ "description": "the Pod ID of the host",
+ "name": "podid",
"type": "string"
},
{
- "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor",
- "name": "cpuallocatedwithoverprovisioning",
- "type": "string"
- },
- {
- "description": "the host's currently allocated disk size",
- "name": "disksizeallocated",
- "type": "long"
- },
- {
- "description": "the cpu average load on the host",
- "name": "cpuloadaverage",
- "type": "double"
- },
- {
- "description": "the host out-of-band management information",
- "name": "outofbandmanagement",
- "type": "outofbandmanagementresponse"
- },
- {},
- {
- "description": "the last time this host was annotated",
- "name": "lastannotated",
- "type": "date"
- },
- {
- "description": "the management server ID of the host",
- "name": "managementserverid",
- "type": "string"
- },
- {
- "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise",
- "name": "hasenoughcapacity",
- "type": "boolean"
- },
- {
- "description": "the total disk size of the host",
- "name": "disksizetotal",
- "type": "long"
- },
- {
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "true if local storage is active, false otherwise",
- "name": "islocalstorageactive",
- "type": "boolean"
- },
- {
- "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise",
- "name": "suitableformigration",
- "type": "boolean"
- },
- {
- "description": "the cluster ID of the host",
- "name": "clusterid",
- "type": "string"
- },
- {
- "description": "the outgoing network traffic on the host",
- "name": "networkkbswrite",
- "type": "long"
- },
- {
- "description": "the host HA information information",
- "name": "hostha",
- "type": "hostharesponse"
- },
- {
- "description": "the Zone name of the host",
- "name": "zonename",
- "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": "capabilities of the host",
- "name": "capabilities",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "Host details in key/value pairs.",
- "name": "details",
- "type": "map"
- },
- {
- "description": "the amount of the host's memory currently used",
- "name": "memoryused",
- "type": "long"
- },
- {
- "description": "the cluster name of the host",
- "name": "clustername",
- "type": "string"
- },
- {
- "description": "the OS category ID of the host",
- "name": "oscategoryid",
- "type": "string"
- },
- {
- "description": "the ID of the host",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the state of the host",
- "name": "state",
- "type": "status"
+ "description": "the host hypervisor",
+ "name": "hypervisor",
+ "type": "hypervisortype"
},
{
"description": "the CPU speed of the host",
@@ -3343,13 +3298,23 @@
"type": "long"
},
{
- "description": "true if the host has capability to support UEFI boot",
- "name": "ueficapability",
- "type": "boolean"
+ "description": "the date and time the host was last pinged",
+ "name": "lastpinged",
+ "type": "date"
},
{
- "description": "the amount of the host's CPU currently used",
- "name": "cpuused",
+ "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning",
+ "name": "memorytotal",
+ "type": "long"
+ },
+ {
+ "description": "the total disk size of the host",
+ "name": "disksizetotal",
+ "type": "long"
+ },
+ {
+ "description": "the Zone ID of the host",
+ "name": "zoneid",
"type": "string"
},
{
@@ -3358,30 +3323,65 @@
"type": "string"
},
{
- "description": "the amount of the host's CPU currently allocated in percentage",
- "name": "cpuallocatedpercentage",
+ "description": "the cpu average load on the host",
+ "name": "cpuloadaverage",
+ "type": "double"
+ },
+ {
+ "description": "the management server ID of the host",
+ "name": "managementserverid",
"type": "string"
},
{
- "description": "the amount of the host's memory after applying the mem.overprovisioning.factor",
- "name": "memorywithoverprovisioning",
+ "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor",
+ "name": "cpuwithoverprovisioning",
"type": "string"
},
{
+ "description": "the cluster ID of the host",
+ "name": "clusterid",
+ "type": "string"
+ },
+ {
+ "description": "the date and time the host was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the number of CPU sockets on the host",
+ "name": "cpusockets",
+ "type": "integer"
+ },
+ {
+ "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",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the host",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the host's memory currently used",
+ "name": "memoryused",
+ "type": "long"
+ },
+ {
"description": "the date and time the host was removed",
"name": "removed",
"type": "date"
},
{
- "description": "the cluster type of the cluster that host belongs to",
- "name": "clustertype",
- "type": "string"
- },
- {},
- {
- "description": "the last annotation set on this host by an admin",
- "name": "annotation",
- "type": "string"
+ "description": "the outgoing network traffic on the host",
+ "name": "networkkbswrite",
+ "type": "long"
}
]
},
@@ -3407,12 +3407,19 @@
}
],
"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"
@@ -3421,13 +3428,6 @@
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
- },
- {},
- {},
- {
- "description": "true if operation is executed successfully",
- "name": "success",
- "type": "boolean"
}
]
},
@@ -3437,17 +3437,9 @@
"name": "listVsphereStoragePolicyCompatiblePools",
"params": [
{
- "description": "ID of the storage policy",
- "length": 255,
- "name": "policyid",
- "related": "importVsphereStoragePolicies,listVsphereStoragePolicies",
- "required": false,
- "type": "uuid"
- },
- {
"description": "",
"length": 255,
- "name": "pagesize",
+ "name": "page",
"required": false,
"type": "integer"
},
@@ -3460,6 +3452,13 @@
"type": "uuid"
},
{
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
"description": "List by keyword",
"length": 255,
"name": "keyword",
@@ -3467,23 +3466,24 @@
"type": "string"
},
{
- "description": "",
+ "description": "ID of the storage policy",
"length": 255,
- "name": "page",
+ "name": "policyid",
+ "related": "importVsphereStoragePolicies,listVsphereStoragePolicies",
"required": false,
- "type": "integer"
+ "type": "uuid"
}
],
"related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities",
"response": [
{
- "description": "the host's currently allocated disk size",
- "name": "disksizeallocated",
- "type": "long"
+ "description": "the ID of the storage pool",
+ "name": "id",
+ "type": "string"
},
{
- "description": "the storage pool path",
- "name": "path",
+ "description": "the name of the storage pool",
+ "name": "name",
"type": "string"
},
{
@@ -3492,11 +3492,123 @@
"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 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 tags for the storage pool",
+ "name": "tags",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the ID of the cluster for the storage pool",
+ "name": "clusterid",
+ "type": "string"
+ },
+ {
+ "description": "the overprovisionfactor for the storage pool",
+ "name": "overprovisionfactor",
+ "type": "string"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the date and time the storage pool was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
"description": "the storage pool capabilities",
"name": "storagecapabilities",
"type": "map"
},
{
+ "description": "IOPS CloudStack can provision from this storage pool",
+ "name": "capacityiops",
+ "type": "long"
+ },
+ {
+ "description": "the scope of the storage pool",
+ "name": "scope",
+ "type": "string"
+ },
+ {
+ "description": "the Zone name of the storage pool",
+ "name": "zonename",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "true if this pool is suitable to migrate a volume, false otherwise",
+ "name": "suitableformigration",
+ "type": "boolean"
+ },
+ {
+ "description": "the Zone ID of the storage pool",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the hypervisor type of the storage pool",
+ "name": "hypervisor",
+ "type": "string"
+ },
+ {
+ "description": "total min IOPS currently in use by volumes",
+ "name": "allocatediops",
+ "type": "long"
+ },
+ {
+ "description": "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 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",
+ "type": "string"
+ },
+ {
+ "description": "the storage pool path",
+ "name": "path",
+ "type": "string"
+ },
+ {
"description": "the storage pool type",
"name": "type",
"type": "string"
@@ -3505,118 +3617,6 @@
"description": "the Pod ID of the storage pool",
"name": "podid",
"type": "string"
- },
- {
- "description": "the ID of the storage pool",
- "name": "id",
- "type": "string"
- },
- {
- "description": "Storage provider for this pool",
- "name": "provider",
- "type": "string"
- },
- {},
- {
- "description": "the tags for the storage pool",
- "name": "tags",
- "type": "string"
- },
- {
- "description": "IOPS CloudStack can provision from this storage pool",
- "name": "capacityiops",
- "type": "long"
- },
- {
- "description": "the date and time the storage pool was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "total min IOPS currently in use by volumes",
- "name": "allocatediops",
- "type": "long"
- },
- {
- "description": "the overprovisionfactor for the storage pool",
- "name": "overprovisionfactor",
- "type": "string"
- },
- {
- "description": "the scope of the storage pool",
- "name": "scope",
- "type": "string"
- },
- {},
- {
- "description": "the host's currently used disk size",
- "name": "disksizeused",
- "type": "long"
- },
- {
- "description": "the state of the storage pool",
- "name": "state",
- "type": "storagepoolstatus"
- },
- {
- "description": "the hypervisor type of the storage pool",
- "name": "hypervisor",
- "type": "string"
- },
- {
- "description": "the name of the cluster for the storage pool",
- "name": "clustername",
- "type": "string"
- },
- {
- "description": "the name of the storage pool",
- "name": "name",
- "type": "string"
- },
- {
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "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": "the UUID of the latest async job acting on 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 name of the storage pool",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "true if this pool is suitable to migrate a volume, false otherwise",
- "name": "suitableformigration",
- "type": "boolean"
- },
- {
- "description": "the ID of the cluster for the storage pool",
- "name": "clusterid",
- "type": "string"
- },
- {
- "description": "the Zone ID of the storage pool",
- "name": "zoneid",
- "type": "string"
}
]
},
@@ -3626,13 +3626,6 @@
"name": "updateStoragePool",
"params": [
{
- "description": "comma-separated list of tags for the storage pool",
- "length": 255,
- "name": "tags",
- "required": false,
- "type": "list"
- },
- {
"description": "IOPS CloudStack can provision from this storage pool",
"length": 255,
"name": "capacityiops",
@@ -3640,21 +3633,6 @@
"type": "long"
},
{
- "description": "false to disable the pool for allocation of new volumes, true to enable it back.",
- "length": 255,
- "name": "enabled",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "the Id of the storage pool",
- "length": 255,
- "name": "id",
- "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities",
- "required": true,
- "type": "uuid"
- },
- {
"description": "Change the name of the storage pool",
"length": 255,
"name": "name",
@@ -3664,33 +3642,61 @@
"type": "string"
},
{
+ "description": "false to disable the pool for allocation of new volumes, true to enable it back.",
+ "length": 255,
+ "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": "bytes CloudStack can provision from this storage pool",
"length": 255,
"name": "capacitybytes",
"required": false,
"type": "long"
+ },
+ {
+ "description": "the Id of the storage pool",
+ "length": 255,
+ "name": "id",
+ "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities",
+ "required": true,
+ "type": "uuid"
}
],
"related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities",
"response": [
{
- "description": "the tags for the storage pool",
- "name": "tags",
+ "description": "the IP address of the storage pool",
+ "name": "ipaddress",
"type": "string"
},
{
- "description": "the name of the storage pool",
- "name": "name",
- "type": "string"
+ "description": "the host's currently allocated disk size",
+ "name": "disksizeallocated",
+ "type": "long"
},
{
- "description": "the ID of the storage pool",
- "name": "id",
- "type": "string"
+ "description": "the total disk size of the storage pool",
+ "name": "disksizetotal",
+ "type": "long"
},
{
- "description": "the hypervisor type of the storage pool",
- "name": "hypervisor",
+ "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",
"type": "string"
},
{
@@ -3699,71 +3705,40 @@
"type": "long"
},
{
- "description": "total min IOPS currently in use by volumes",
- "name": "allocatediops",
- "type": "long"
- },
- {
- "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": "Storage provider for this pool",
- "name": "provider",
+ "description": "the storage pool type",
+ "name": "type",
"type": "string"
},
{
- "description": "the Zone name of the storage pool",
- "name": "zonename",
- "type": "string"
- },
- {},
- {
- "description": "the Zone ID of the storage pool",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "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",
- "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 storage pool",
"name": "podid",
"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": "the total disk size of the storage pool",
- "name": "disksizetotal",
- "type": "long"
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {},
+ {
+ "description": "the 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 name of the storage pool",
+ "name": "name",
+ "type": "string"
},
{
"description": "IOPS CloudStack can provision from this storage pool",
@@ -3776,23 +3751,33 @@
"type": "string"
},
{
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "the overprovisionfactor for the storage pool",
- "name": "overprovisionfactor",
+ "description": "the tags for the storage pool",
+ "name": "tags",
"type": "string"
},
{
- "description": "the name of the cluster for the storage pool",
- "name": "clustername",
+ "description": "the Zone name of the storage pool",
+ "name": "zonename",
"type": "string"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the ID of the storage pool",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the storage pool path",
+ "name": "path",
+ "type": "string"
+ },
+ {
+ "description": "the Pod name of the storage pool",
+ "name": "podname",
+ "type": "string"
+ },
+ {
+ "description": "Storage provider for this pool",
+ "name": "provider",
"type": "string"
},
{
@@ -3801,18 +3786,33 @@
"type": "date"
},
{
- "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 storage pool path",
- "name": "path",
+ "description": "the hypervisor type of the storage pool",
+ "name": "hypervisor",
"type": "string"
},
{
- "description": "the storage pool type",
- "name": "type",
+ "description": "the Zone ID of the storage pool",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the storage pool capabilities",
+ "name": "storagecapabilities",
+ "type": "map"
+ },
+ {
+ "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"
}
],
@@ -3843,74 +3843,19 @@
"related": "destroySystemVm,listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm",
"response": [
{
- "description": "the Pod name for the system VM",
- "name": "podname",
- "type": "string"
- },
- {
- "description": "the system VM type",
- "name": "systemvmtype",
- "type": "string"
- },
- {
- "description": "the date and time the system VM was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the 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 Pod ID for the system VM",
- "name": "podid",
- "type": "string"
- },
- {
- "description": "the public MAC address for the system VM",
- "name": "publicmacaddress",
- "type": "string"
- },
- {
- "description": "the last disconnected date of host",
- "name": "disconnected",
- "type": "date"
- },
- {
- "description": "the link local MAC address for the system vm",
- "name": "linklocalmacaddress",
- "type": "string"
- },
- {
- "description": "the network domain for the system VM",
- "name": "networkdomain",
- "type": "string"
- },
- {
- "description": "the second DNS for the system VM",
- "name": "dns2",
+ "description": "the Zone name for the system VM",
+ "name": "zonename",
"type": "string"
},
{},
{
- "description": "the link local IP address for the system vm",
- "name": "linklocalip",
+ "description": "the Zone ID for the system VM",
+ "name": "zoneid",
"type": "string"
},
{
- "description": "the link local netmask for the system vm",
- "name": "linklocalnetmask",
- "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"
},
{
@@ -3919,18 +3864,43 @@
"type": "string"
},
{
- "description": "public vlan range",
- "name": "publicvlan",
- "type": "list"
+ "description": "the Pod name for the system VM",
+ "name": "podname",
+ "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": "guest vlan range",
- "name": "guestvlan",
+ "description": "the public MAC address for the system VM",
+ "name": "publicmacaddress",
+ "type": "string"
+ },
+ {
+ "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.",
+ "name": "isdynamicallyscalable",
+ "type": "boolean"
+ },
+ {
+ "description": "the state of the system VM",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "the public netmask for the system VM",
+ "name": "publicnetmask",
+ "type": "string"
+ },
+ {
+ "description": "the link local IP address for the system vm",
+ "name": "linklocalip",
+ "type": "string"
+ },
+ {
+ "description": "the hostname for the system VM",
+ "name": "hostname",
"type": "string"
},
{
@@ -3939,11 +3909,56 @@
"type": "string"
},
{
+ "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",
+ "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",
+ "type": "string"
+ },
+ {
+ "description": "the agent state of the system VM",
+ "name": "agentstate",
+ "type": "string"
+ },
+ {
+ "description": "the Pod ID for the system VM",
+ "name": "podid",
+ "type": "string"
+ },
+ {
"description": "the private MAC address for the system VM",
"name": "privatemacaddress",
"type": "string"
},
{
+ "description": "the hypervisor on which the template runs",
+ "name": "hypervisor",
+ "type": "string"
+ },
+ {
+ "description": "the link local MAC address for the system vm",
+ "name": "linklocalmacaddress",
+ "type": "string"
+ },
+ {
+ "description": "the date and time the system VM was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
"description": "the template ID for the system VM",
"name": "templateid",
"type": "string"
@@ -3953,14 +3968,10 @@
"name": "jobstatus",
"type": "integer"
},
+ {},
{
- "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 network domain for the system VM",
+ "name": "networkdomain",
"type": "string"
},
{
@@ -3969,30 +3980,14 @@
"type": "string"
},
{
- "description": "the Zone ID for the system VM",
- "name": "zoneid",
+ "description": "the private IP address for the system VM",
+ "name": "privateip",
"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"
- },
- {
- "description": "the agent state of the system VM",
- "name": "agentstate",
- "type": "string"
- },
- {
- "description": "the Zone name for the system VM",
- "name": "zonename",
- "type": "string"
+ "description": "the last disconnected date of host",
+ "name": "disconnected",
+ "type": "date"
},
{
"description": "the gateway for the system VM",
@@ -4000,44 +3995,49 @@
"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",
- "type": "string"
- },
- {
- "description": "the hostname for the system VM",
- "name": "hostname",
- "type": "string"
- },
- {
- "description": "the public netmask for the system VM",
- "name": "publicnetmask",
- "type": "string"
- },
- {
- "description": "the systemvm agent version",
- "name": "version",
- "type": "string"
- },
- {
"description": "the host ID for the system VM",
"name": "hostid",
"type": "string"
},
{
+ "description": "guest vlan range",
+ "name": "guestvlan",
+ "type": "string"
+ },
+ {
"description": "the name of the system VM",
"name": "name",
"type": "string"
},
{
- "description": "the state of the system VM",
- "name": "state",
+ "description": "the number of active console sessions for the console proxy system vm",
+ "name": "activeviewersessions",
+ "type": "integer"
+ },
+ {
+ "description": "the link local netmask for the system vm",
+ "name": "linklocalnetmask",
"type": "string"
+ },
+ {
+ "description": "the public IP address for the system VM",
+ "name": "publicip",
+ "type": "string"
+ },
+ {
+ "description": "public vlan range",
+ "name": "publicvlan",
+ "type": "list"
+ },
+ {
+ "description": "the systemvm agent version",
+ "name": "version",
+ "type": "string"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
}
]
},
@@ -4047,29 +4047,6 @@
"name": "importLdapUsers",
"params": [
{
- "description": "details for account used to store specific parameters",
- "length": 255,
- "name": "accountdetails",
- "required": false,
- "type": "map"
- },
- {
- "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": "domainid",
- "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "Creates the account under the specified role.",
- "length": 255,
- "name": "roleid",
- "related": "createRole,importRole,listRoles,updateRole",
- "required": false,
- "type": "uuid"
- },
- {
"description": "Creates the user under the specified account. If no account is specified, the username will be used as the account name.",
"length": 255,
"name": "account",
@@ -4077,27 +4054,6 @@
"type": "string"
},
{
- "description": "",
- "length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
- },
- {
- "description": "Specifies the group name from which the ldap users are to be imported. If no group is specified, all the users will be imported.",
- "length": 255,
- "name": "group",
- "required": false,
- "type": "string"
- },
- {
- "description": "",
- "length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
- },
- {
"description": "List by keyword",
"length": 255,
"name": "keyword",
@@ -4117,18 +4073,62 @@
"name": "accounttype",
"required": false,
"type": "short"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "Specifies the group name from which the ldap users are to be imported. If no group is specified, all the users will be imported.",
+ "length": 255,
+ "name": "group",
+ "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",
+ "length": 255,
+ "name": "domainid",
+ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "Creates the account under the specified role.",
+ "length": 255,
+ "name": "roleid",
+ "related": "createRole,importRole,listRoles,updateRole",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "details for account used to store specific parameters",
+ "length": 255,
+ "name": "accountdetails",
+ "required": false,
+ "type": "map"
}
],
"related": "searchLdap,listLdapUsers",
"response": [
{
- "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 email",
+ "name": "email",
"type": "string"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "The user's username",
+ "name": "username",
"type": "string"
},
{
@@ -4136,9 +4136,10 @@
"name": "firstname",
"type": "string"
},
+ {},
{
- "description": "The user's email",
- "name": "email",
+ "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"
},
{
@@ -4147,23 +4148,22 @@
"type": "string"
},
{
- "description": "The user's principle",
- "name": "principal",
- "type": "string"
- },
- {},
- {},
- {
"description": "The user's lastname",
"name": "lastname",
"type": "string"
},
{
- "description": "The user's username",
- "name": "username",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
+ "description": "The user's principle",
+ "name": "principal",
+ "type": "string"
+ },
+ {},
+ {
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
@@ -4177,13 +4177,6 @@
"name": "listNetworks",
"params": [
{
- "description": "",
- "length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
- },
- {
"description": "true if network is system, false otherwise",
"length": 255,
"name": "issystem",
@@ -4191,79 +4184,6 @@
"type": "boolean"
},
{
- "description": "flag to display the resource icon for networks",
- "length": 255,
- "name": "showicon",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter",
- "length": 255,
- "name": "displaynetwork",
- "required": false,
- "since": "4.4",
- "type": "boolean"
- },
- {
- "description": "true if need to list only networks which support specifying IP ranges",
- "length": 255,
- "name": "specifyipranges",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "list networks by ID",
- "length": 255,
- "name": "id",
- "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "List networks by VPC",
- "length": 255,
- "name": "vpcid",
- "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "list networks supporting certain services",
- "length": 255,
- "name": "supportedservices",
- "required": false,
- "type": "list"
- },
- {
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
- },
- {
- "description": "list networks by restartRequired",
- "length": 255,
- "name": "restartrequired",
- "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 networks by ACL (access control list) type. Supported values are account and domain",
- "length": 255,
- "name": "acltype",
- "required": false,
- "type": "string"
- },
- {
"description": "",
"length": 255,
"name": "pagesize",
@@ -4271,9 +4191,9 @@
"type": "integer"
},
{
- "description": "list networks available for VM deployment",
+ "description": "true if need to list only networks which support specifying IP ranges",
"length": 255,
- "name": "canusefordeploy",
+ "name": "specifyipranges",
"required": false,
"type": "boolean"
},
@@ -4285,6 +4205,13 @@
"type": "string"
},
{
+ "description": "type of the traffic",
+ "length": 255,
+ "name": "traffictype",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "list only resources belonging to the domain specified",
"length": 255,
"name": "domainid",
@@ -4301,6 +4228,80 @@
"type": "uuid"
},
{
+ "description": "list networks supporting certain services",
+ "length": 255,
+ "name": "supportedservices",
+ "required": false,
+ "type": "list"
+ },
+ {
+ "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter",
+ "length": 255,
+ "name": "displaynetwork",
+ "required": false,
+ "since": "4.4",
+ "type": "boolean"
+ },
+ {
+ "description": "List networks by VPC",
+ "length": 255,
+ "name": "vpcid",
+ "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "list networks by ID",
+ "length": 255,
+ "name": "id",
+ "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks",
+ "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",
+ "length": 255,
+ "name": "listall",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "list networks available for VM deployment",
+ "length": 255,
+ "name": "canusefordeploy",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "List resources by tags (key/value pairs)",
+ "length": 255,
+ "name": "tags",
+ "required": false,
+ "type": "map"
+ },
+ {
+ "description": "list networks by restartRequired",
+ "length": 255,
+ "name": "restartrequired",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "the zone ID of the network",
+ "length": 255,
+ "name": "zoneid",
+ "related": "createZone,updateZone,listZones,listZones",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "flag to display the resource icon for networks",
+ "length": 255,
+ "name": "showicon",
+ "required": false,
+ "type": "boolean"
+ },
+ {
"description": "the network belongs to VPC",
"length": 255,
"name": "forvpc",
@@ -4308,6 +4309,20 @@
"type": "boolean"
},
{
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
+ "length": 255,
+ "name": "isrecursive",
+ "required": false,
+ "type": "boolean"
+ },
+ {
"description": "list networks by physical network id",
"length": 255,
"name": "physicalnetworkid",
@@ -4316,38 +4331,9 @@
"type": "uuid"
},
{
- "description": "List resources by tags (key/value pairs)",
+ "description": "list resources by account. Must be used with the domainId parameter.",
"length": 255,
- "name": "tags",
- "required": false,
- "type": "map"
- },
- {
- "description": "the zone ID of the network",
- "length": 255,
- "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",
- "length": 255,
- "name": "listall",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
- "length": 255,
- "name": "isrecursive",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "type of the traffic",
- "length": 255,
- "name": "traffictype",
+ "name": "account",
"required": false,
"type": "string"
},
@@ -4358,132 +4344,57 @@
"related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject",
"required": false,
"type": "uuid"
+ },
+ {
+ "description": "list networks by ACL (access control list) type. Supported values are account and domain",
+ "length": 255,
+ "name": "acltype",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
}
],
"related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks",
"response": [
{
- "description": "the network's netmask",
- "name": "netmask",
- "type": "string"
- },
- {
- "description": "list networks available for vm deployment",
- "name": "canusefordeploy",
+ "description": "true network requires restart",
+ "name": "restartrequired",
"type": "boolean"
},
{
- "description": "Broadcast domain type of the network",
- "name": "broadcastdomaintype",
- "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 list of resource tags associated with network",
- "name": "tags",
- "response": [
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "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": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- }
- ],
- "type": "list"
+ "description": "the details of the network",
+ "name": "details",
+ "type": "map"
},
- {},
{
"description": "the project name of the address",
"name": "project",
"type": "string"
},
{
- "description": "availability of the network offering the network is created from",
- "name": "networkofferingavailability",
- "type": "string"
- },
- {
- "description": "display text of the network offering the network is created from",
- "name": "networkofferingdisplaytext",
- "type": "string"
- },
- {
- "description": "the first DNS for the network",
- "name": "dns1",
- "type": "string"
- },
- {
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
- },
- {
- "description": "If the network has redundant routers enabled",
- "name": "redundantrouter",
- "type": "boolean"
- },
- {},
- {
- "description": "The external id of the network",
- "name": "externalid",
- "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": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "an optional field, whether to the display the network to the end user or not.",
+ "name": "displaynetwork",
+ "type": "boolean"
+ },
+ {
+ "description": "the gateway of IPv6 network",
+ "name": "ip6gateway",
"type": "string"
},
{
@@ -4492,34 +4403,39 @@
"type": "string"
},
{
- "description": "the name of the zone the network belongs to",
- "name": "zonename",
+ "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": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes",
+ "name": "reservediprange",
"type": "string"
},
{
- "description": "the domain name of the network owner",
- "name": "domain",
+ "description": "Broadcast domain type of the network",
+ "name": "broadcastdomaintype",
"type": "string"
},
{
- "description": "true if network is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
- },
- {
- "description": "network offering id the network is created from",
- "name": "networkofferingid",
+ "description": "Name of the VPC to which this network belongs",
+ "name": "vpcname",
"type": "string"
},
{
- "description": "true if users from subdomains can access the domain level network",
- "name": "subdomainaccess",
- "type": "boolean"
+ "description": "the network domain",
+ "name": "networkdomain",
+ "type": "string"
+ },
+ {
+ "description": "the name of the network",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the total number of network traffic bytes sent",
+ "name": "sentbytes",
+ "type": "long"
},
{
"description": "true if the entity/resource has annotations",
@@ -4532,28 +4448,39 @@
"type": "string"
},
{
- "description": "the displaytext of the network",
- "name": "displaytext",
+ "description": "the domain id of the network owner",
+ "name": "domainid",
"type": "string"
},
{
- "description": "the type of the network",
- "name": "type",
+ "description": "the traffic type of the network",
+ "name": "traffictype",
"type": "string"
},
{
- "description": "the total number of network traffic bytes received",
- "name": "receivedbytes",
- "type": "long"
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
},
{
+ "description": "the date this network was created",
+ "name": "created",
+ "type": "date"
+ },
+ {},
+ {
"description": "the physical network id",
"name": "physicalnetworkid",
"type": "string"
},
{
- "description": "the id of the network",
- "name": "id",
+ "description": "The external id of the network",
+ "name": "externalid",
+ "type": "string"
+ },
+ {
+ "description": "network offering id the network is created from",
+ "name": "networkofferingid",
"type": "string"
},
{
@@ -4562,13 +4489,201 @@
"type": "string"
},
{
+ "description": "the second DNS for the network",
+ "name": "dns2",
+ "type": "string"
+ },
+ {
+ "description": "ACL Id associated with the VPC network",
+ "name": "aclid",
+ "type": "string"
+ },
+ {
+ "description": "availability of the network offering the network is created from",
+ "name": "networkofferingavailability",
+ "type": "string"
+ },
+ {
+ "description": "the id of the network",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "name of the network offering the network is created from",
+ "name": "networkofferingname",
+ "type": "string"
+ },
+ {
+ "description": "related to what other network configuration",
+ "name": "related",
+ "type": "string"
+ },
+ {
+ "description": "the name of the zone the network belongs to",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "zone id of the network",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
"description": "acl type - access type to the network",
"name": "acltype",
"type": "string"
},
{
- "description": "the name of the network",
- "name": "name",
+ "description": "the network's netmask",
+ "name": "netmask",
+ "type": "string"
+ },
+ {
+ "description": "true if users from subdomains can access the domain level network",
+ "name": "subdomainaccess",
+ "type": "boolean"
+ },
+ {
+ "description": "If the network has redundant routers enabled",
+ "name": "redundantrouter",
+ "type": "boolean"
+ },
+ {
+ "description": "list networks that are persistent",
+ "name": "ispersistent",
+ "type": "boolean"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the cidr of IPv6 network",
+ "name": "ip6cidr",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the owner of the network",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE",
+ "name": "networkcidr",
+ "type": "string"
+ },
+ {
+ "description": "the first DNS for the network",
+ "name": "dns1",
+ "type": "string"
+ },
+ {
+ "description": "true if network can span multiple zones",
+ "name": "strechedl2subnet",
+ "type": "boolean"
+ },
+ {
+ "description": "the list of resource tags associated with network",
+ "name": "tags",
+ "response": [
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "tag 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 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": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ }
+ ],
+ "type": "list"
+ },
+ {
+ "description": "true if network supports specifying ip ranges, false otherwise",
+ "name": "specifyipranges",
+ "type": "boolean"
+ },
+ {
+ "description": "the project id of the ipaddress",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "VPC the network belongs to",
+ "name": "vpcid",
+ "type": "string"
+ },
+ {
+ "description": "broadcast uri of the network. This parameter is visible to ROOT admins only",
+ "name": "broadcasturi",
+ "type": "string"
+ },
+ {
+ "description": "list networks available for vm deployment",
+ "name": "canusefordeploy",
+ "type": "boolean"
+ },
+ {
+ "description": "ACL name associated with the VPC network",
+ "name": "aclname",
+ "type": "string"
+ },
+ {
+ "description": "the domain name of the network owner",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the total number of network traffic bytes received",
+ "name": "receivedbytes",
+ "type": "long"
+ },
+ {
+ "description": "the displaytext of the network",
+ "name": "displaytext",
"type": "string"
},
{
@@ -4576,15 +4691,30 @@
"name": "service",
"response": [
{
+ "description": "the service name",
+ "name": "name",
+ "type": "string"
+ },
+ {
"description": "the service provider name",
"name": "provider",
"response": [
{
- "description": "the provider name",
- "name": "name",
+ "description": "the destination physical network",
+ "name": "destinationphysicalnetworkid",
"type": "string"
},
{
+ "description": "state of the network provider",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "true if individual services can be enabled/disabled",
+ "name": "canenableindividualservice",
+ "type": "boolean"
+ },
+ {
"description": "services for this provider",
"name": "servicelist",
"type": "list"
@@ -4595,21 +4725,11 @@
"type": "string"
},
{
- "description": "state of the network provider",
- "name": "state",
+ "description": "the provider name",
+ "name": "name",
"type": "string"
},
{
- "description": "the destination physical network",
- "name": "destinationphysicalnetworkid",
- "type": "string"
- },
- {
- "description": "true if individual services can be enabled/disabled",
- "name": "canenableindividualservice",
- "type": "boolean"
- },
- {
"description": "the physical network this belongs to",
"name": "physicalnetworkid",
"type": "string"
@@ -4618,11 +4738,6 @@
"type": "list"
},
{
- "description": "the service name",
- "name": "name",
- "type": "string"
- },
- {
"description": "the list of capabilities",
"name": "capability",
"response": [
@@ -4632,14 +4747,14 @@
"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"
@@ -4648,144 +4763,29 @@
"type": "list"
},
{
- "description": "Name of the VPC to which this network belongs",
- "name": "vpcname",
+ "description": "display text of the network offering the network is created from",
+ "name": "networkofferingdisplaytext",
"type": "string"
},
{
- "description": "the second DNS for the network",
- "name": "dns2",
+ "description": "the type of the network",
+ "name": "type",
"type": "string"
},
{
- "description": "true if network supports specifying ip ranges, false otherwise",
- "name": "specifyipranges",
+ "description": "true if network offering is ip conserve mode enabled",
+ "name": "networkofferingconservemode",
"type": "boolean"
},
{
- "description": "name of the network offering the network is created from",
- "name": "networkofferingname",
- "type": "string"
- },
- {
- "description": "zone id of the network",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the gateway of IPv6 network",
- "name": "ip6gateway",
- "type": "string"
- },
- {
- "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes",
- "name": "reservediprange",
- "type": "string"
- },
- {
- "description": "an optional field, whether to the display the network to the end user or not.",
- "name": "displaynetwork",
- "type": "boolean"
- },
- {
- "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 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 cidr of IPv6 network",
- "name": "ip6cidr",
- "type": "string"
- },
- {
- "description": "the project id of the ipaddress",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "ACL Id associated with the VPC network",
- "name": "aclid",
- "type": "string"
- },
- {
- "description": "broadcast uri of the network. This parameter is visible to ROOT admins only",
- "name": "broadcasturi",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "true network requires restart",
- "name": "restartrequired",
- "type": "boolean"
- },
- {
- "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR",
- "name": "cidr",
- "type": "string"
- },
- {
- "description": "true if network is system, false otherwise",
- "name": "issystem",
- "type": "boolean"
- },
- {
- "description": "ACL name associated with the VPC network",
- "name": "aclname",
- "type": "string"
- },
- {
- "description": "the network domain",
- "name": "networkdomain",
- "type": "string"
- },
- {
- "description": "the details of the network",
- "name": "details",
- "type": "map"
- },
- {
- "description": "VPC the network belongs to",
- "name": "vpcid",
- "type": "string"
- },
- {
- "description": "the date this network was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "list networks that are persistent",
- "name": "ispersistent",
- "type": "boolean"
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
},
{
"description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans",
"name": "zonesnetworkspans",
"type": "set"
- },
- {
- "description": "the owner of the network",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the total number of network traffic bytes sent",
- "name": "sentbytes",
- "type": "long"
}
]
},
@@ -4795,6 +4795,14 @@
"name": "listDedicatedZones",
"params": [
{
+ "description": "the ID of the Zone",
+ "length": 255,
+ "name": "zoneid",
+ "related": "createZone,updateZone,listZones,listZones",
+ "required": false,
+ "type": "uuid"
+ },
+ {
"description": "",
"length": 255,
"name": "pagesize",
@@ -4802,14 +4810,6 @@
"type": "integer"
},
{
- "description": "the ID of the domain associated with the zone",
- "length": 255,
- "name": "domainid",
- "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
- "required": false,
- "type": "uuid"
- },
- {
"description": "List by keyword",
"length": 255,
"name": "keyword",
@@ -4817,13 +4817,6 @@
"type": "string"
},
{
- "description": "the name of the account associated with the zone. Must be used with domainId.",
- "length": 255,
- "name": "account",
- "required": false,
- "type": "string"
- },
- {
"description": "",
"length": 255,
"name": "page",
@@ -4839,57 +4832,64 @@
"type": "uuid"
},
{
- "description": "the ID of the Zone",
+ "description": "the ID of the domain associated with the zone",
"length": 255,
- "name": "zoneid",
- "related": "createZone,updateZone,listZones,listZones",
+ "name": "domainid",
+ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
"required": false,
"type": "uuid"
+ },
+ {
+ "description": "the name of the account associated with the zone. Must be used with domainId.",
+ "length": 255,
+ "name": "account",
+ "required": false,
+ "type": "string"
}
],
"related": "dedicateZone",
"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 Account Id to which the Zone is dedicated",
- "name": "accountid",
- "type": "string"
- },
- {},
- {
- "description": "the ID of the Zone",
- "name": "zoneid",
- "type": "string"
- },
- {
"description": "the Name of the Zone",
"name": "zonename",
"type": "string"
},
+ {},
+ {},
+ {
+ "description": "the domain ID to which the Zone is dedicated",
+ "name": "domainid",
+ "type": "string"
+ },
{
"description": "the Dedication Affinity Group ID of the zone",
"name": "affinitygroupid",
"type": "string"
},
{
- "description": "the domain ID to which the Zone is dedicated",
- "name": "domainid",
+ "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 UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
"description": "the ID of the dedicated resource",
"name": "id",
"type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
}
]
},
@@ -4909,34 +4909,35 @@
"related": "",
"response": [
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the name of the storage pool",
- "name": "name",
- "type": "string"
- },
- {
"description": "the ID of the storage pool",
"name": "id",
"type": "string"
},
{
+ "description": "controller of the pool",
+ "name": "controllerid",
+ "type": "string"
+ },
+ {
+ "description": "available iops of the pool",
+ "name": "maxiops",
+ "type": "long"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {},
+ {
"description": "the state of the storage pool",
"name": "state",
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "available iops of the pool",
- "name": "maxiops",
- "type": "long"
+ "description": "the name of the storage pool",
+ "name": "name",
+ "type": "string"
},
{},
{
@@ -4945,16 +4946,15 @@
"type": "long"
},
{
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
"description": "default gateway of the pool",
"name": "gateway",
"type": "string"
- },
- {
- "description": "controller of the pool",
- "name": "controllerid",
- "type": "string"
- },
- {}
+ }
]
},
{
@@ -4963,6 +4963,14 @@
"name": "updatePodManagementNetworkIpRange",
"params": [
{
+ "description": "UUID of POD, where the IP range belongs to.",
+ "length": 255,
+ "name": "podid",
+ "related": "listPods,updatePod,createManagementNetworkIpRange",
+ "required": true,
+ "type": "uuid"
+ },
+ {
"description": "The new ending IP address.",
"length": 255,
"name": "newendip",
@@ -4970,14 +4978,6 @@
"type": "string"
},
{
- "description": "The current starting IP address.",
- "length": 255,
- "name": "currentstartip",
- "related": "listPods,updatePod,createManagementNetworkIpRange",
- "required": true,
- "type": "string"
- },
- {
"description": "The new starting IP address.",
"length": 255,
"name": "newstartip",
@@ -4985,45 +4985,45 @@
"type": "string"
},
{
- "description": "UUID of POD, where the IP range belongs to.",
- "length": 255,
- "name": "podid",
- "related": "listPods,updatePod,createManagementNetworkIpRange",
- "required": true,
- "type": "uuid"
- },
- {
"description": "The current ending IP address.",
"length": 255,
"name": "currentendip",
"related": "listPods,updatePod,createManagementNetworkIpRange",
"required": true,
"type": "string"
+ },
+ {
+ "description": "The current starting IP address.",
+ "length": 255,
+ "name": "currentstartip",
+ "related": "listPods,updatePod,createManagementNetworkIpRange",
+ "required": true,
+ "type": "string"
}
],
"response": [
- {},
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
+ {},
+ {
+ "description": "true if operation is executed successfully",
+ "name": "success",
+ "type": "boolean"
+ },
+ {},
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
{
- "description": "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.16.0.0"
},
@@ -5033,6 +5033,14 @@
"name": "updateFirewallRule",
"params": [
{
+ "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only",
+ "length": 255,
+ "name": "customid",
+ "required": false,
+ "since": "4.4",
+ "type": "string"
+ },
+ {
"description": "the ID of the firewall rule",
"length": 255,
"name": "id",
@@ -5047,69 +5055,71 @@
"required": false,
"since": "4.4",
"type": "boolean"
- },
- {
- "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only",
- "length": 255,
- "name": "customid",
- "required": false,
- "since": "4.4",
- "type": "string"
}
],
"related": "createEgressFirewallRule,createFirewallRule,listEgressFirewallRules,listFirewallRules,updateEgressFirewallRule",
"response": [
{
- "description": "the ending port of firewall rule's port range",
- "name": "endport",
- "type": "integer"
- },
- {},
- {
- "description": "the public ip address for the firewall rule",
- "name": "ipaddress",
- "type": "string"
- },
- {
"description": "the 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 network id of the firewall rule",
- "name": "networkid",
- "type": "string"
- },
- {
- "description": "type of the icmp message being sent",
- "name": "icmptype",
- "type": "integer"
- },
- {
- "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).",
- "name": "destcidrlist",
- "type": "string"
- },
- {
- "description": "error code for this icmp message",
- "name": "icmpcode",
- "type": "integer"
- },
- {},
- {
- "description": "the state of the rule",
- "name": "state",
- "type": "string"
- },
- {
- "description": "the protocol of the firewall rule",
- "name": "protocol",
- "type": "string"
+ "description": "the list of resource tags associated with the rule",
+ "name": "tags",
+ "response": [
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "the 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": "customer associated with the tag",
+ "name": "customer",
+ "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",
@@ -5122,66 +5132,9 @@
"type": "string"
},
{
- "description": "is rule for display to the regular user",
- "name": "fordisplay",
- "type": "boolean"
- },
- {
- "description": "the list of resource tags associated with the rule",
- "name": "tags",
- "response": [
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- }
- ],
- "type": "list"
+ "description": "the public ip address for the firewall rule",
+ "name": "ipaddress",
+ "type": "string"
},
{
"description": "the starting port of firewall rule's port range",
@@ -5189,9 +5142,56 @@
"type": "integer"
},
{
+ "description": "the network id of the firewall rule",
+ "name": "networkid",
+ "type": "string"
+ },
+ {
+ "description": "type of the icmp message being sent",
+ "name": "icmptype",
+ "type": "integer"
+ },
+ {},
+ {
+ "description": "the state of the rule",
+ "name": "state",
+ "type": "string"
+ },
+ {
"description": "the public ip address id for the firewall rule",
"name": "ipaddressid",
"type": "string"
+ },
+ {
+ "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).",
+ "name": "destcidrlist",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the ending port of firewall rule's port range",
+ "name": "endport",
+ "type": "integer"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "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 protocol of the firewall rule",
+ "name": "protocol",
+ "type": "string"
}
],
"since": "4.4"
@@ -5203,23 +5203,23 @@
"params": [],
"related": "",
"response": [
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "is quota service enabled",
- "name": "isenabled",
- "type": "boolean"
- },
+ {},
{},
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
- {}
+ {
+ "description": "is quota service enabled",
+ "name": "isenabled",
+ "type": "boolean"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ }
],
"since": "4.7.0"
},
@@ -5229,6 +5229,13 @@
"name": "listSrxFirewalls",
"params": [
{
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ },
+ {
"description": "SRX firewall device ID",
"length": 255,
"name": "fwdeviceid",
@@ -5237,11 +5244,12 @@
"type": "uuid"
},
{
- "description": "List by keyword",
+ "description": "the Physical Network ID",
"length": 255,
- "name": "keyword",
+ "name": "physicalnetworkid",
+ "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork",
"required": false,
- "type": "string"
+ "type": "uuid"
},
{
"description": "",
@@ -5251,56 +5259,28 @@
"type": "integer"
},
{
- "description": "",
+ "description": "List by keyword",
"length": 255,
- "name": "page",
+ "name": "keyword",
"required": false,
- "type": "integer"
- },
- {
- "description": "the Physical Network ID",
- "length": 255,
- "name": "physicalnetworkid",
- "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork",
- "required": false,
- "type": "uuid"
+ "type": "string"
}
],
"related": "addSrxFirewall,configureSrxFirewall",
"response": [
{
- "description": "the number of times to retry requests to the external firewall",
- "name": "numretries",
- "type": "string"
- },
- {
- "description": "device name",
- "name": "fwdevicename",
- "type": "string"
- },
- {
- "description": "the public security zone of the external firewall",
- "name": "publiczone",
- "type": "string"
- },
- {
"description": "the physical network to which this SRX firewall belongs to",
"name": "physicalnetworkid",
"type": "string"
},
{
- "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": "device capacity",
- "name": "fwdevicecapacity",
- "type": "long"
- },
- {
- "description": "device state",
- "name": "fwdevicestate",
+ "description": "name of the provider",
+ "name": "provider",
"type": "string"
},
{
@@ -5309,29 +5289,29 @@
"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",
+ "description": "the username that's used to log in to the external firewall",
+ "name": "username",
"type": "string"
},
{
- "description": "the public interface of the external firewall",
- "name": "publicinterface",
- "type": "string"
- },
- {},
- {
"description": "the private interface of the external firewall",
"name": "privateinterface",
"type": "string"
},
{
- "description": "the private security zone of the external firewall",
- "name": "privatezone",
+ "description": "the public security zone of the external firewall",
+ "name": "publiczone",
+ "type": "string"
+ },
+ {
+ "description": "the usage interface of the external firewall",
+ "name": "usageinterface",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the number of times to retry requests to the external firewall",
+ "name": "numretries",
"type": "string"
},
{
@@ -5340,8 +5320,28 @@
"type": "string"
},
{
- "description": "the zone ID of the external firewall",
- "name": "zoneid",
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "device state",
+ "name": "fwdevicestate",
+ "type": "string"
+ },
+ {
+ "description": "the private security zone of the external firewall",
+ "name": "privatezone",
+ "type": "string"
+ },
+ {
+ "description": "device capacity",
+ "name": "fwdevicecapacity",
+ "type": "long"
+ },
+ {
+ "description": "the timeout (in seconds) for requests to the external firewall",
+ "name": "timeout",
"type": "string"
},
{},
@@ -5351,13 +5351,13 @@
"type": "string"
},
{
- "description": "the username that's used to log in to the external firewall",
- "name": "username",
+ "description": "the public interface of the external firewall",
+ "name": "publicinterface",
"type": "string"
},
{
- "description": "name of the provider",
- "name": "provider",
+ "description": "device name",
+ "name": "fwdevicename",
"type": "string"
}
]
@@ -5389,22 +5389,22 @@
"name": "success",
"type": "boolean"
},
- {},
- {},
+ {
+ "description": "any text associated with the success or failure",
+ "name": "displaytext",
+ "type": "string"
+ },
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
+ {},
+ {},
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
- },
- {
- "description": "any text associated with the success or failure",
- "name": "displaytext",
- "type": "string"
}
],
"since": "3.0.0"
@@ -5431,12 +5431,12 @@
"name": "jobstatus",
"type": "integer"
},
+ {},
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
- {},
{
"description": "Hypervisor name",
"name": "name",
@@ -5457,55 +5457,55 @@
"type": "string"
},
{
+ "description": "Map of (key/value pairs)",
+ "length": 255,
+ "name": "details",
+ "required": true,
+ "type": "map"
+ },
+ {
"description": "UUID of the Guest OS",
"length": 255,
"name": "id",
"related": "listOsTypes,addGuestOs,updateGuestOs",
"required": true,
"type": "uuid"
- },
- {
- "description": "Map of (key/value pairs)",
- "length": 255,
- "name": "details",
- "required": true,
- "type": "map"
}
],
"related": "listOsTypes,addGuestOs",
"response": [
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
{
- "description": "the ID of the OS type",
- "name": "id",
- "type": "string"
- },
- {
- "description": "is the guest OS user defined",
- "name": "isuserdefined",
- "type": "boolean"
- },
- {
"description": "the ID of the OS category",
"name": "oscategoryid",
"type": "string"
},
+ {},
{
"description": "the name/description of the OS type",
"name": "description",
"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 user defined",
+ "name": "isuserdefined",
+ "type": "boolean"
+ }
],
"since": "4.4.0"
},
@@ -5523,6 +5523,13 @@
"type": "uuid"
},
{
+ "description": "Type of resource to update. Values are 0, 1, 2, 3, 4, 6, 7, 8, 9, 10 and 11. 0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create. 3 - Snapshot. Number of snapshots a user can create. 4 - Template. Number of templates that a user can register/create. 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",
@@ -5538,13 +5545,6 @@
"type": "uuid"
},
{
- "description": "Type of resource to update. Values are 0, 1, 2, 3, 4, 6, 7, 8, 9, 10 and 11. 0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create. 3 - Snapshot. Number of snapshots a user can create. 4 - Template. Number of templates that a user can register/create. 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": " Maximum resource limit.",
"length": 255,
"name": "max",
@@ -5560,9 +5560,9 @@
"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",
- "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",
@@ -5571,36 +5571,36 @@
},
{},
{
- "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",
"type": "string"
},
{
+ "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 project id of the resource limit",
- "name": "projectid",
- "type": "string"
- },
- {},
- {
"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",
+ "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",
@@ -5624,9 +5624,9 @@
],
"response": [
{
- "description": "any text associated with the success or failure",
- "name": "displaytext",
- "type": "string"
+ "description": "true if operation is executed successfully",
+ "name": "success",
+ "type": "boolean"
},
{
"description": "the current status of the latest async job acting on this object",
@@ -5639,12 +5639,12 @@
"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"
+ }
]
},
{
@@ -5653,6 +5653,13 @@
"name": "listHostsMetrics",
"params": [
{
+ "description": "comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]",
+ "length": 255,
+ "name": "details",
+ "required": false,
+ "type": "list"
+ },
+ {
"description": "the id of the host",
"length": 255,
"name": "id",
@@ -5668,57 +5675,14 @@
"type": "string"
},
{
- "description": "the Pod ID for the host",
+ "description": "lists hosts existing in particular cluster",
"length": 255,
- "name": "podid",
- "related": "listPods,updatePod,createManagementNetworkIpRange",
+ "name": "clusterid",
+ "related": "addCluster,listClusters,updateCluster",
"required": false,
"type": "uuid"
},
{
- "description": "if true, list only hosts dedicated to HA",
- "length": 255,
- "name": "hahost",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "list hosts for which out-of-band management is enabled",
- "length": 255,
- "name": "outofbandmanagementenabled",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
- },
- {
- "description": "lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM",
- "length": 255,
- "name": "virtualmachineid",
- "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,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",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "",
- "length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
- },
- {
- "description": "comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]",
- "length": 255,
- "name": "details",
- "required": false,
- "type": "list"
- },
- {
"description": "the Zone ID for the host",
"length": 255,
"name": "zoneid",
@@ -5748,6 +5712,50 @@
"type": "integer"
},
{
+ "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": "lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM",
+ "length": 255,
+ "name": "virtualmachineid",
+ "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,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",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "list hosts for which out-of-band management is enabled",
+ "length": 255,
+ "name": "outofbandmanagementenabled",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the Pod ID for the host",
+ "length": 255,
+ "name": "podid",
+ "related": "listPods,updatePod,createManagementNetworkIpRange",
+ "required": false,
+ "type": "uuid"
+ },
+ {
"description": "the host type",
"length": 255,
"name": "type",
@@ -5762,29 +5770,287 @@
"type": "string"
},
{
- "description": "lists hosts existing in particular cluster",
+ "description": "if true, list only hosts dedicated to HA",
"length": 255,
- "name": "clusterid",
- "related": "addCluster,listClusters,updateCluster",
+ "name": "hahost",
"required": false,
- "type": "uuid"
- },
- {
- "description": "list hosts by resource state. Resource state represents current state determined by admin of host, value can be one of [Enabled, Disabled, Unmanaged, PrepareForMaintenance, ErrorInMaintenance, Maintenance, Error]",
- "length": 255,
- "name": "resourcestate",
- "required": false,
- "type": "string"
+ "type": "boolean"
}
],
"related": "",
"response": [
{
+ "description": "cpu usage notification threshold exceeded",
+ "name": "cputhreshold",
+ "type": "boolean"
+ },
+ {
+ "description": "the total disk size of the host",
+ "name": "disksizetotal",
+ "type": "long"
+ },
+ {
+ "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": "the total cpu allocated in Ghz",
+ "name": "cpuallocatedghz",
+ "type": "string"
+ },
+ {
+ "description": "the Zone name of the host",
+ "name": "zonename",
+ "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": "cpu allocated notification threshold exceeded",
+ "name": "cpuallocatedthreshold",
+ "type": "boolean"
+ },
+ {
+ "description": "true if local storage is active, false otherwise",
+ "name": "islocalstorageactive",
+ "type": "boolean"
+ },
+ {
+ "description": "the total memory used in GiB",
+ "name": "memoryusedgb",
+ "type": "string"
+ },
+ {
+ "description": "the cluster name of the host",
+ "name": "clustername",
+ "type": "string"
+ },
+ {
+ "description": "cpu usage disable threshold exceeded",
+ "name": "cpudisablethreshold",
+ "type": "boolean"
+ },
+ {
+ "description": "comma-separated list of tags for the host",
+ "name": "hosttags",
+ "type": "string"
+ },
+ {
+ "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise",
+ "name": "hahost",
+ "type": "boolean"
+ },
+ {
+ "description": "the CPU number of the host",
+ "name": "cpunumber",
+ "type": "integer"
+ },
+ {
+ "description": "the date and time the host was last pinged",
+ "name": "lastpinged",
+ "type": "date"
+ },
+ {
+ "description": "the outgoing network traffic on the host",
+ "name": "networkkbswrite",
+ "type": "long"
+ },
+ {
+ "description": "the host version",
+ "name": "version",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the host's CPU currently allocated",
+ "name": "cpuallocated",
+ "type": "string"
+ },
+ {
+ "description": "out-of-band management power state",
+ "name": "powerstate",
+ "type": "powerstate"
+ },
+ {
+ "description": "the host's currently allocated disk size",
+ "name": "disksizeallocated",
+ "type": "long"
+ },
+ {
+ "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 amount of the host's CPU after applying the cpu.overprovisioning.factor",
+ "name": "cpuwithoverprovisioning",
+ "type": "string"
+ },
+ {
+ "description": "the average cpu load the last minute",
+ "name": "cpuloadaverage",
+ "type": "double"
+ },
+ {
+ "description": "Host details in key/value pairs.",
+ "name": "details",
+ "type": "map"
+ },
+ {
+ "description": "the admin that annotated this host",
+ "name": "username",
+ "type": "string"
+ },
+ {
+ "description": "the host out-of-band management information",
+ "name": "outofbandmanagement",
+ "type": "outofbandmanagementresponse"
+ },
+ {
+ "description": "the CPU speed of the host",
+ "name": "cpuspeed",
+ "type": "long"
+ },
+ {
+ "description": "cpu allocated disable threshold exceeded",
+ "name": "cpuallocateddisablethreshold",
+ "type": "boolean"
+ },
+ {
+ "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise",
+ "name": "suitableformigration",
+ "type": "boolean"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the last time this host was annotated",
+ "name": "lastannotated",
+ "type": "date"
+ },
+ {
+ "description": "memory allocated notification threshold exceeded",
+ "name": "memoryallocatedthreshold",
+ "type": "boolean"
+ },
+ {
+ "description": "the Zone ID of the host",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "capabilities of the host",
+ "name": "capabilities",
+ "type": "string"
+ },
+ {
+ "description": "memory allocated disable threshold exceeded",
+ "name": "memoryallocateddisablethreshold",
+ "type": "boolean"
+ },
+ {
+ "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise",
+ "name": "hasenoughcapacity",
+ "type": "boolean"
+ },
+ {
+ "description": "the IP address of the host",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the amount of the host's memory currently allocated",
+ "name": "memoryallocated",
+ "type": "long"
+ },
+ {
+ "description": "the date and time the host was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor",
+ "name": "cpuallocatedwithoverprovisioning",
+ "type": "string"
+ },
+ {
+ "description": "the total cpu used in Ghz",
+ "name": "cpuusedghz",
+ "type": "string"
+ },
+ {
+ "description": "the Pod ID of the host",
+ "name": "podid",
+ "type": "string"
+ },
+ {
+ "description": "the total memory allocated in GiB",
+ "name": "memoryallocatedgb",
+ "type": "string"
+ },
+ {
+ "description": "the resource state of the host",
+ "name": "resourcestate",
+ "type": "string"
+ },
+ {
"description": "the host HA information information",
"name": "hostha",
"type": "hostharesponse"
},
{
+ "description": "the cluster type of the cluster that host belongs to",
+ "name": "clustertype",
+ "type": "string"
+ },
+ {
+ "description": "the management server ID of the host",
+ "name": "managementserverid",
+ "type": "string"
+ },
+ {
+ "description": "the Pod name of the host",
+ "name": "podname",
+ "type": "string"
+ },
+ {
+ "description": "the total cpu capacity in Ghz",
+ "name": "cputotalghz",
+ "type": "string"
+ },
+ {
+ "description": "instances on the host",
+ "name": "instances",
+ "type": "string"
+ },
+ {
+ "description": "network read in GiB",
+ "name": "networkread",
+ "type": "string"
+ },
+ {
"description": "true if the entity/resource has annotations",
"name": "hasannotations",
"type": "boolean"
@@ -5803,23 +6069,23 @@
"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": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type",
+ "name": "remainingcapacity",
+ "type": "long"
+ },
+ {
"description": "Maximum displays per user",
"name": "maxheads",
"type": "long"
},
{
- "description": "Maximum 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"
},
{
@@ -5828,6 +6094,11 @@
"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"
@@ -5836,11 +6107,6 @@
"description": "Maximum Y resolution per display",
"name": "maxresolutiony",
"type": "long"
- },
- {
- "description": "Maximum X resolution per display",
- "name": "maxresolutionx",
- "type": "long"
}
],
"type": "list"
@@ -5849,9 +6115,14 @@
"type": "list"
},
{
- "description": "the CPU speed of the host",
- "name": "cpuspeed",
- "type": "long"
+ "description": "the ID of the host",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the cpu average load on the host",
+ "name": "cpuloadaverage",
+ "type": "double"
},
{
"description": "the last annotation set on this host by an admin",
@@ -5859,175 +6130,34 @@
"type": "string"
},
{
- "description": "the Pod name of the host",
- "name": "podname",
- "type": "string"
- },
- {
- "description": "the hypervisor version",
- "name": "hypervisorversion",
- "type": "string"
- },
- {
- "description": "events available for the host",
- "name": "events",
- "type": "string"
- },
- {
- "description": "the host type",
- "name": "type",
- "type": "type"
- },
- {
- "description": "the outgoing network traffic on the host",
- "name": "networkkbswrite",
- "type": "long"
- },
- {
- "description": "the cluster name of the host",
- "name": "clustername",
- "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 admin that annotated this host",
- "name": "username",
- "type": "string"
- },
- {
- "description": "memory allocated disable threshold exceeded",
- "name": "memoryallocateddisablethreshold",
- "type": "boolean"
- },
- {
- "description": "the Zone ID of the host",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the total cpu allocated in Ghz",
- "name": "cpuallocatedghz",
- "type": "string"
- },
- {
- "description": "the amount of the host's CPU currently allocated",
- "name": "cpuallocated",
- "type": "string"
- },
- {
- "description": "the total cpu capacity in Ghz",
- "name": "cputotalghz",
- "type": "string"
- },
- {
- "description": "the management server ID of the host",
- "name": "managementserverid",
- "type": "string"
- },
- {
- "description": "the Zone name of the host",
- "name": "zonename",
- "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 memory total of the host, this parameter is deprecated use memorywithoverprovisioning",
- "name": "memorytotal",
- "type": "long"
- },
- {
- "description": "cpu allocated notification threshold exceeded",
- "name": "cpuallocatedthreshold",
- "type": "boolean"
- },
- {
- "description": "the Pod ID of the host",
- "name": "podid",
- "type": "string"
- },
- {
- "description": "the cluster type of the cluster that host belongs to",
- "name": "clustertype",
- "type": "string"
- },
- {
- "description": "out-of-band management power state",
- "name": "powerstate",
- "type": "powerstate"
- },
- {
- "description": "true if local storage is active, false otherwise",
- "name": "islocalstorageactive",
- "type": "boolean"
- },
- {
- "description": "the host hypervisor",
- "name": "hypervisor",
- "type": "hypervisortype"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the amount of the host's memory currently allocated",
- "name": "memoryallocated",
- "type": "long"
- },
- {
- "description": "the total memory allocated in GiB",
- "name": "memoryallocatedgb",
- "type": "string"
- },
- {
"description": "the incoming network traffic on the host",
"name": "networkkbsread",
"type": "long"
},
{
- "description": "the average cpu load the last minute",
- "name": "cpuloadaverage",
- "type": "double"
+ "description": "the host hypervisor",
+ "name": "hypervisor",
+ "type": "hypervisortype"
},
{
- "description": "memory allocated notification threshold exceeded",
- "name": "memoryallocatedthreshold",
- "type": "boolean"
- },
- {
- "description": "memory usage disable threshold exceeded",
- "name": "memorydisablethreshold",
- "type": "boolean"
- },
- {
- "description": "the amount of the host's CPU currently allocated in MHz",
- "name": "cpuallocatedvalue",
- "type": "long"
- },
- {
- "description": "the name of the host",
- "name": "name",
+ "description": "the amount of the host's CPU currently allocated in percentage",
+ "name": "cpuallocatedpercentage",
"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 amount of the host's memory currently used",
+ "name": "memoryused",
+ "type": "long"
+ },
+ {
+ "description": "the OS category ID of the host",
+ "name": "oscategoryid",
+ "type": "string"
},
{
"description": "the number of CPU sockets on the host",
@@ -6035,19 +6165,14 @@
"type": "integer"
},
{
- "description": "the host out-of-band management information",
- "name": "outofbandmanagement",
- "type": "outofbandmanagementresponse"
- },
- {
- "description": "the total memory used in GiB",
- "name": "memoryusedgb",
+ "description": "the amount of the host's memory currently allocated in percentage",
+ "name": "memoryallocatedpercentage",
"type": "string"
},
{
- "description": "instances on the host",
- "name": "instances",
- "type": "string"
+ "description": "the host type",
+ "name": "type",
+ "type": "type"
},
{
"description": "the total memory capacity in GiB",
@@ -6055,34 +6180,23 @@
"type": "string"
},
{
- "description": "the CPU number of the host",
- "name": "cpunumber",
- "type": "integer"
+ "description": "memory usage disable threshold exceeded",
+ "name": "memorydisablethreshold",
+ "type": "boolean"
},
{
- "description": "the total cpu used in Ghz",
- "name": "cpuusedghz",
+ "description": "network write in GiB",
+ "name": "networkwrite",
"type": "string"
},
{
- "description": "the total disk size of the host",
- "name": "disksizetotal",
- "type": "long"
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
},
{
- "description": "the date and time the host was last pinged",
- "name": "lastpinged",
- "type": "date"
- },
- {
- "description": "the date and time the host was created",
- "name": "created",
- "type": "date"
- },
- {},
- {
- "description": "the amount of the host's CPU currently allocated in percentage",
- "name": "cpuallocatedpercentage",
+ "description": "the hypervisor version",
+ "name": "hypervisorversion",
"type": "string"
},
{
@@ -6091,128 +6205,13 @@
"type": "boolean"
},
{
- "description": "cpu allocated disable threshold exceeded",
- "name": "cpuallocateddisablethreshold",
- "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",
- "type": "string"
- },
- {
- "description": "the cluster ID of the host",
- "name": "clusterid",
- "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 version",
- "name": "version",
- "type": "string"
- },
- {
- "description": "Host details in key/value pairs.",
- "name": "details",
- "type": "map"
- },
- {
- "description": "cpu usage disable threshold exceeded",
- "name": "cpudisablethreshold",
- "type": "boolean"
- },
- {
- "description": "memory usage notification threshold exceeded",
- "name": "memorythreshold",
- "type": "boolean"
- },
- {
- "description": "cpu usage notification threshold exceeded",
- "name": "cputhreshold",
- "type": "boolean"
- },
- {
- "description": "the cpu average load on the host",
- "name": "cpuloadaverage",
- "type": "double"
- },
- {
- "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": "true if the host is disconnected. False otherwise.",
- "name": "disconnected",
- "type": "date"
- },
- {
- "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise",
- "name": "hasenoughcapacity",
- "type": "boolean"
- },
- {
- "description": "the last time this host was annotated",
- "name": "lastannotated",
- "type": "date"
- },
- {
- "description": "comma-separated list of tags for the host",
- "name": "hosttags",
- "type": "string"
- },
- {
- "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 ID of the host",
- "name": "id",
- "type": "string"
- },
- {
- "description": "network read in GiB",
- "name": "networkread",
- "type": "string"
- },
- {
- "description": "the amount of the host's memory currently allocated in percentage",
- "name": "memoryallocatedpercentage",
- "type": "string"
- },
- {
- "description": "the IP address of the host",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "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 amount of the host's CPU after applying the cpu.overprovisioning.factor",
- "name": "cpuwithoverprovisioning",
+ "description": "events available for the host",
+ "name": "events",
"type": "string"
},
{
@@ -6221,19 +6220,20 @@
"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 amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor",
- "name": "cpuallocatedwithoverprovisioning",
- "type": "string"
- },
- {
- "description": "capabilities of the host",
- "name": "capabilities",
- "type": "string"
+ "description": "memory usage notification threshold exceeded",
+ "name": "memorythreshold",
+ "type": "boolean"
}
],
"since": "4.9.3"
@@ -6253,22 +6253,22 @@
}
],
"response": [
- {},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
+ "description": "true if operation is executed successfully",
+ "name": "success",
+ "type": "boolean"
},
{},
+ {},
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
{
- "description": "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",
@@ -6283,11 +6283,12 @@
"name": "listAffinityGroups",
"params": [
{
- "description": "List by keyword",
+ "description": "list objects by project",
"length": 255,
- "name": "keyword",
+ "name": "projectid",
+ "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject",
"required": false,
- "type": "string"
+ "type": "uuid"
},
{
"description": "list resources by account. Must be used with the domainId parameter.",
@@ -6297,43 +6298,6 @@
"type": "string"
},
{
- "description": "list only resources belonging to the domain specified",
- "length": 255,
- "name": "domainid",
- "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
- "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": "lists affinity groups by name",
- "length": 255,
- "name": "name",
- "required": false,
- "type": "string"
- },
- {
- "description": "lists affinity groups by virtual machine ID",
- "length": 255,
- "name": "virtualmachineid",
- "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,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",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "",
- "length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
- },
- {
"description": "lists affinity groups by type",
"length": 255,
"name": "type",
@@ -6341,16 +6305,9 @@
"type": "string"
},
{
- "description": "",
+ "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
"length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
- },
- {
- "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false",
- "length": 255,
- "name": "listall",
+ "name": "isrecursive",
"required": false,
"type": "boolean"
},
@@ -6363,19 +6320,67 @@
"type": "uuid"
},
{
- "description": "list objects by project",
+ "description": "List by keyword",
"length": 255,
- "name": "projectid",
- "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject",
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "lists affinity groups by virtual machine ID",
+ "length": 255,
+ "name": "virtualmachineid",
+ "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,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",
"required": false,
"type": "uuid"
+ },
+ {
+ "description": "list only resources belonging to the domain specified",
+ "length": 255,
+ "name": "domainid",
+ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "lists affinity groups by name",
+ "length": 255,
+ "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",
+ "length": 255,
+ "name": "listall",
+ "required": false,
+ "type": "boolean"
}
],
"related": "createAffinityGroup",
"response": [
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the project name of the affinity group",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the name of the affinity group",
+ "name": "name",
"type": "string"
},
{
@@ -6384,57 +6389,52 @@
"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": "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 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 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"
+ },
+ {
+ "description": "the description of the affinity group",
+ "name": "description",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID of the affinity group",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
"description": "the project ID of the affinity group",
"name": "projectid",
"type": "string"
},
{
- "description": "the current status of the latest async job acting 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 owning the affinity group",
+ "name": "account",
+ "type": "string"
+ },
+ {}
]
},
{
@@ -6443,20 +6443,6 @@
"name": "registerSSHKeyPair",
"params": [
{
- "description": "an optional account for the ssh key. Must be used with domainId.",
- "length": 255,
- "name": "account",
- "required": false,
- "type": "string"
- },
- {
- "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",
@@ -6472,35 +6458,38 @@
"type": "string"
},
{
+ "description": "Public key material of the keypair",
+ "length": 5120,
+ "name": "publickey",
+ "required": true,
+ "type": "string"
+ },
+ {
"description": "an optional domainId for the ssh key. If the account parameter is used, domainId must also be used.",
"length": 255,
"name": "domainid",
"related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
"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 domain id of the keypair owner",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {},
- {
"description": "Name of the keypair",
"name": "name",
"type": "string"
},
{
- "description": "Fingerprint of the public key",
- "name": "fingerprint",
+ "description": "the domain id of the keypair owner",
+ "name": "domainid",
"type": "string"
},
{
@@ -6509,10 +6498,11 @@
"type": "integer"
},
{
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
},
+ {},
{
"description": "the domain name of the keypair owner",
"name": "domain",
@@ -6528,7 +6518,17 @@
"name": "id",
"type": "string"
},
- {}
+ {},
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "Fingerprint of the public key",
+ "name": "fingerprint",
+ "type": "string"
+ }
]
},
{
@@ -6576,13 +6576,6 @@
"name": "startRollingMaintenance",
"params": [
{
- "description": "the command to execute while hosts are on maintenance",
- "length": 255,
- "name": "payload",
- "required": false,
- "type": "string"
- },
- {
"description": "if rolling mechanism should continue in case of an error",
"length": 255,
"name": "forced",
@@ -6590,6 +6583,21 @@
"type": "boolean"
},
{
+ "description": "the IDs of the zones to start maintenance on",
+ "length": 255,
+ "name": "zoneids",
+ "related": "createZone,updateZone,listZones,listZones",
+ "required": false,
+ "type": "list"
+ },
+ {
+ "description": "the command to execute while hosts are on maintenance",
+ "length": 255,
+ "name": "payload",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "the IDs of the pods to start maintenance on",
"length": 255,
"name": "podids",
@@ -6598,22 +6606,6 @@
"type": "list"
},
{
- "description": "the IDs of the clusters to start maintenance on",
- "length": 255,
- "name": "clusterids",
- "related": "addCluster,listClusters,updateCluster",
- "required": false,
- "type": "list"
- },
- {
- "description": "the IDs of the hosts to start maintenance on",
- "length": 255,
- "name": "hostids",
- "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost,listExternalLoadBalancers",
- "required": false,
- "type": "list"
- },
- {
"description": "optional operation timeout (in seconds) that overrides the global timeout setting",
"length": 255,
"name": "timeout",
@@ -6621,34 +6613,43 @@
"type": "integer"
},
{
- "description": "the IDs of the zones to start maintenance on",
+ "description": "the IDs of the hosts to start maintenance on",
"length": 255,
- "name": "zoneids",
- "related": "createZone,updateZone,listZones,listZones",
+ "name": "hostids",
+ "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost,listExternalLoadBalancers",
+ "required": false,
+ "type": "list"
+ },
+ {
+ "description": "the IDs of the clusters to start maintenance on",
+ "length": 255,
+ "name": "clusterids",
+ "related": "addCluster,listClusters,updateCluster",
"required": false,
"type": "list"
}
],
"related": "",
"response": [
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
{},
{
- "description": "in case of failure, details are displayed",
- "name": "details",
- "type": "string"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
+ {},
{
"description": "the hosts updated",
"name": "hostsupdated",
"response": [
{
- "description": "start date of the update on the host",
- "name": "startdate",
+ "description": "the name of the updated host",
+ "name": "hostname",
+ "type": "string"
+ },
+ {
+ "description": "output of the maintenance script on the host",
+ "name": "output",
"type": "string"
},
{
@@ -6657,24 +6658,34 @@
"type": "string"
},
{
- "description": "the name of the updated host",
- "name": "hostname",
- "type": "string"
- },
- {
"description": "end date of the update on the host",
"name": "enddate",
"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"
}
],
"type": "list"
},
{
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "indicates if the rolling maintenance operation was successful",
+ "name": "success",
+ "type": "boolean"
+ },
+ {
+ "description": "in case of failure, details are displayed",
+ "name": "details",
+ "type": "string"
+ },
+ {
"description": "the hosts skipped",
"name": "hostsskipped",
"response": [
@@ -6684,28 +6695,17 @@
"type": "string"
},
{
- "description": "the ID of the skipped host",
- "name": "hostid",
+ "description": "the name of the skipped host",
+ "name": "hostname",
"type": "string"
},
{
- "description": "the name of the skipped host",
- "name": "hostname",
+ "description": "the ID of the skipped host",
+ "name": "hostid",
"type": "string"
}
],
"type": "list"
- },
- {
- "description": "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"
}
]
},
@@ -6715,6 +6715,14 @@
"name": "updateNetworkACLList",
"params": [
{
+ "description": "the ID of the network ACL",
+ "length": 255,
+ "name": "id",
+ "related": "createNetworkACLList,listNetworkACLLists",
+ "required": true,
+ "type": "uuid"
+ },
+ {
"description": "an optional field, whether to the display the list to the end user or not",
"length": 255,
"name": "fordisplay",
@@ -6723,14 +6731,6 @@
"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": "Name of the network ACL list",
"length": 255,
"name": "name",
@@ -6745,28 +6745,16 @@
"type": "string"
},
{
- "description": "the ID of the network ACL",
+ "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": "createNetworkACLList,listNetworkACLLists",
- "required": true,
- "type": "uuid"
+ "name": "customid",
+ "required": false,
+ "since": "4.4",
+ "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"
@@ -6775,7 +6763,19 @@
"description": "true if operation is executed successfully",
"name": "success",
"type": "boolean"
- }
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {},
+ {}
],
"since": "4.4"
},
@@ -6804,76 +6804,13 @@
"related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,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",
"response": [
{
- "description": "the target memory in vm",
- "name": "memorytargetkbs",
- "type": "long"
+ "description": "the memory allocated for the virtual machine",
+ "name": "memory",
+ "type": "integer"
},
{
- "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 project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "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": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the name of the availability zone for the virtual machine",
- "name": "zonename",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
@@ -6882,98 +6819,8 @@
"type": "string"
},
{
- "description": "the write (bytes) of disk on the vm",
- "name": "diskkbswrite",
- "type": "long"
- },
- {
- "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": "Vm details in key/value pairs.",
- "name": "details",
- "type": "map"
- },
- {
- "description": "an optional field whether to the display the vm to the end user or not.",
- "name": "displayvm",
- "type": "boolean"
- },
- {
- "description": "the account associated with the virtual machine",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the memory used by the vm",
- "name": "memorykbs",
- "type": "long"
- },
- {
- "description": "the ID of the disk offering of the virtual machine",
- "name": "diskofferingid",
- "type": "string"
- },
- {
- "description": "the internal memory 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": "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": "Guest vm Boot Type",
- "name": "boottype",
- "type": "string"
- },
- {
- "description": "the ID of the virtual machine",
- "name": "id",
- "type": "string"
- },
- {
- "description": "device type of the root volume",
- "name": "rootdevicetype",
- "type": "string"
- },
- {
- "description": " an alternate display text of the template for the virtual machine",
- "name": "templatedisplaytext",
- "type": "string"
- },
- {
- "description": "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": "OS type id of the vm",
- "name": "ostypeid",
+ "description": "the ID of the backup offering of the virtual machine",
+ "name": "backupofferingid",
"type": "string"
},
{
@@ -6982,345 +6829,181 @@
"type": "string"
},
{
- "description": "the name of the ISO attached to the virtual machine",
- "name": "isoname",
- "type": "string"
- },
- {
- "description": "the outgoing network traffic on the host",
- "name": "networkkbswrite",
+ "description": "the read (bytes) of disk on the vm",
+ "name": "diskkbsread",
"type": "long"
},
{
- "description": "the virtual network for the service offering",
- "name": "forvirtualnetwork",
- "type": "boolean"
- },
- {
- "description": "the ID of the ISO attached to the virtual machine",
- "name": "isoid",
- "type": "string"
- },
- {},
- {
- "description": "ssh key-pair",
- "name": "keypair",
- "type": "string"
- },
- {
"description": "the name of the disk offering of the virtual machine",
"name": "diskofferingname",
"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": "the total number of network traffic bytes sent",
- "name": "sentbytes",
+ "description": "the incoming network traffic on the vm",
+ "name": "networkkbsread",
"type": "long"
},
{
- "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 state of the virtual machine",
- "name": "state",
- "type": "string"
- },
- {
- "description": "the write (io) of disk on the vm",
- "name": "diskiowrite",
- "type": "long"
- },
- {
- "description": "the ID of the domain in which the virtual machine exists",
- "name": "domainid",
- "type": "string"
- },
- {
"description": "List of read-only Vm details as comma separated string.",
"name": "readonlydetails",
"type": "string"
},
{
- "description": "the name of the service offering of the virtual machine",
- "name": "serviceofferingname",
+ "description": "the ID of the availablility zone for the virtual machine",
+ "name": "zoneid",
"type": "string"
},
{
- "description": "public IP address id associated with vm via Static nat rule",
- "name": "publicipid",
+ "description": "the name of the virtual machine",
+ "name": "name",
"type": "string"
},
{
- "description": "OS name of the vm",
- "name": "osdisplayname",
- "type": "string"
- },
- {
- "description": "the memory allocated for the virtual machine",
- "name": "memory",
- "type": "integer"
- },
- {
- "description": "the project name of the vm",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the group ID of the virtual machine",
- "name": "groupid",
- "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": "device ID of the root volume",
- "name": "rootdeviceid",
+ "description": "the internal memory that's free in vm or zero if it can not be calculated",
+ "name": "memoryintfreekbs",
"type": "long"
},
- {},
{
- "description": "the list of nics associated with vm",
- "name": "nic",
- "response": [
- {
- "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise",
- "name": "nsxlogicalswitchport",
- "type": "string"
- },
- {
- "description": "the traffic type of the nic",
- "name": "traffictype",
- "type": "string"
- },
- {
- "description": "the cidr of IPv6 network",
- "name": "ip6cidr",
- "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 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": "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 ID of the nic",
- "name": "id",
- "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 type if available",
- "name": "isolatedpvlantype",
- "type": "string"
- },
- {
- "description": "the Secondary ipv4 addr of nic",
- "name": "secondaryip",
- "type": "list"
- },
- {
- "description": "Type of adapter if available",
- "name": "adaptertype",
- "type": "string"
- },
- {
- "description": "Id of the vm to which the nic belongs",
- "name": "virtualmachineid",
- "type": "string"
- },
- {
- "description": "device id for the network when plugged into the virtual machine",
- "name": "deviceid",
- "type": "string"
- },
- {
- "description": "the isolated private VLAN if available",
- "name": "isolatedpvlan",
- "type": "integer"
- },
- {
- "description": "the IPv6 address of network",
- "name": "ip6address",
- "type": "string"
- },
- {
- "description": "the name of the corresponding network",
- "name": "networkname",
- "type": "string"
- },
- {
- "description": "the ip address of the nic",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "description": "the gateway of IPv6 network",
- "name": "ip6gateway",
- "type": "string"
- },
- {
- "description": "the netmask of the nic",
- "name": "netmask",
- "type": "string"
- },
- {
- "description": "the broadcast uri of the nic",
- "name": "broadcasturi",
- "type": "string"
- },
- {
- "description": "IP addresses associated with NIC found for unmanaged VM",
- "name": "ipaddresses",
- "type": "list"
- }
- ],
- "type": "set"
- },
- {
- "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.",
- "name": "templateid",
+ "description": "ssh key-pair",
+ "name": "keypair",
"type": "string"
},
{
- "description": "true if the password rest feature is enabled, false otherwise",
- "name": "passwordenabled",
- "type": "boolean"
- },
- {
- "description": "the read (io) of disk on the vm",
- "name": "diskioread",
- "type": "long"
- },
- {
"description": "list of affinity groups associated with the virtual machine",
"name": "affinitygroup",
"response": [
{
- "description": "the 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",
- "type": "string"
- },
- {
"description": "the domain name of the affinity group",
"name": "domain",
"type": "string"
},
{
- "description": "the project name of the affinity group",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the type of the affinity group",
- "name": "type",
- "type": "string"
- },
- {
- "description": "the name of the affinity group",
- "name": "name",
- "type": "string"
- },
- {
"description": "the project ID of the affinity group",
"name": "projectid",
"type": "string"
},
{
+ "description": "the name of the affinity group",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the 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 ID of the affinity group",
+ "name": "id",
+ "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 domain ID of the affinity group",
- "name": "domainid",
+ "description": "the type of the affinity group",
+ "name": "type",
"type": "string"
}
],
"type": "set"
},
{
- "description": "the name of the virtual machine",
- "name": "name",
+ "description": "instance name of the user vm; this parameter is returned to the ROOT admin only",
+ "name": "instancename",
"type": "string"
},
{
- "description": "the speed of each cpu",
- "name": "cpuspeed",
- "type": "integer"
+ "description": "the name of the domain in which the virtual machine exists",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "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": " an alternate display text of the template for the virtual machine",
+ "name": "templatedisplaytext",
+ "type": "string"
+ },
+ {
+ "description": "Vm details in key/value pairs.",
+ "name": "details",
+ "type": "map"
+ },
+ {
+ "description": "public IP address id associated with vm via Static nat rule",
+ "name": "publicipid",
+ "type": "string"
+ },
+ {
+ "description": "the project id of the vm",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the ISO attached to the virtual machine",
+ "name": "isoname",
+ "type": "string"
+ },
+ {
+ "description": "device type of the root volume",
+ "name": "rootdevicetype",
+ "type": "string"
+ },
+ {
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "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 password (if exists) of the virtual machine",
+ "name": "password",
+ "type": "string"
+ },
+ {
+ "description": "an alternate display text of the ISO attached to the virtual machine",
+ "name": "isodisplaytext",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the service offering of the virtual machine",
+ "name": "serviceofferingid",
+ "type": "string"
},
{
"description": "the vgpu type used by the virtual machine",
@@ -7328,8 +7011,34 @@
"type": "string"
},
{
- "description": "State of the Service from LB rule",
- "name": "servicestate",
+ "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.",
+ "name": "isdynamicallyscalable",
+ "type": "boolean"
+ },
+ {
+ "description": "Guest vm Boot Mode",
+ "name": "bootmode",
+ "type": "string"
+ },
+ {
+ "description": "the 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 date when this virtual machine was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the name of the host for the virtual machine",
+ "name": "hostname",
"type": "string"
},
{
@@ -7337,132 +7046,45 @@
"name": "securitygroup",
"response": [
{
- "description": "the domain name of the security group",
- "name": "domain",
- "type": "string"
- },
- {
"description": "the description of the security group",
"name": "description",
"type": "string"
},
{
- "description": "the project name of the group",
- "name": "project",
- "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 number of virtualmachines associated with this securitygroup",
- "name": "virtualmachinecount",
- "type": "integer"
- },
- {
"description": "the account owning the security group",
"name": "account",
"type": "string"
},
{
+ "description": "the domain name of the security group",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the 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 starting IP of the security group rule",
- "name": "startport",
- "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": "security group name",
- "name": "securitygroupname",
- "type": "string"
- },
- {
- "description": "the list of resource tags associated with the rule",
- "name": "tags",
- "response": [
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "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 domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
"description": "the code for the ICMP message response",
"name": "icmpcode",
"type": "integer"
},
{
+ "description": "the starting IP of the security group rule",
+ "name": "startport",
+ "type": "integer"
+ },
+ {
"description": "the id of the security group rule",
"name": "ruleid",
"type": "string"
@@ -7473,79 +7095,94 @@
"type": "string"
},
{
- "description": "the ending IP of the security group rule ",
- "name": "endport",
- "type": "integer"
- }
- ],
- "type": "set"
- },
- {
- "description": "the list of resource tags associated with the rule",
- "name": "tags",
- "response": [
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the 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": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
+ "description": "account owning the security group rule",
"name": "account",
"type": "string"
},
{
- "description": "resource type",
- "name": "resourcetype",
+ "description": "the CIDR notation for the base IP address of the security group rule",
+ "name": "cidr",
"type": "string"
},
{
- "description": "the project id the tag belongs to",
- "name": "projectid",
+ "description": "the ending IP of the security group rule ",
+ "name": "endport",
+ "type": "integer"
+ },
+ {
+ "description": "security group name",
+ "name": "securitygroupname",
"type": "string"
+ },
+ {
+ "description": "the list of resource tags associated with the rule",
+ "name": "tags",
+ "response": [
+ {
+ "description": "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 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 id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ }
+ ],
+ "type": "set"
}
],
"type": "set"
},
{
- "description": "the ID of the security group",
- "name": "id",
+ "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 ID of the security group",
+ "name": "domainid",
+ "type": "string"
},
{
"description": "the list of ingress rules associated with the security group",
@@ -7557,16 +7194,36 @@
"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 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 id of the security group rule",
"name": "ruleid",
"type": "string"
@@ -7581,28 +7238,8 @@
"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": "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"
},
{
@@ -7611,13 +7248,28 @@
"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": "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"
},
{
@@ -7626,32 +7278,74 @@
"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",
"type": "string"
}
],
"type": "set"
- },
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the list of resource tags associated with the rule",
+ "name": "tags",
+ "response": [
{
- "description": "the ending IP of the security group rule ",
- "name": "endport",
- "type": "integer"
- },
- {
- "description": "account owning the security group rule",
+ "description": "the account associated with the tag",
"name": "account",
"type": "string"
},
{
- "description": "the starting IP of the security group rule",
- "name": "startport",
- "type": "integer"
+ "description": "tag value",
+ "name": "value",
+ "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": "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": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
}
],
"type": "set"
@@ -7660,28 +7354,58 @@
"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 project name of the group",
+ "name": "project",
+ "type": "string"
}
],
"type": "set"
},
{
- "description": "the read (bytes) of disk on the vm",
- "name": "diskkbsread",
+ "description": "the memory used by the vm",
+ "name": "memorykbs",
"type": "long"
},
{
- "description": "the pool type of the virtual machine",
- "name": "pooltype",
+ "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 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": "State of the Service from LB rule",
+ "name": "servicestate",
"type": "string"
},
{
- "description": "an alternate display text of the ISO attached to the virtual machine",
- "name": "isodisplaytext",
+ "description": "the total number of network traffic bytes sent",
+ "name": "sentbytes",
+ "type": "long"
+ },
+ {
+ "description": "the ID of the domain in which the virtual machine exists",
+ "name": "domainid",
"type": "string"
},
{
@@ -7690,43 +7414,18 @@
"type": "integer"
},
{
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "the ID of the backup offering of the virtual machine",
- "name": "backupofferingid",
+ "description": "the ID of the virtual machine",
+ "name": "id",
"type": "string"
},
{
- "description": "the name of the backup offering of the virtual machine",
- "name": "backupofferingname",
- "type": "string"
+ "description": "the target memory in vm",
+ "name": "memorytargetkbs",
+ "type": "long"
},
{
- "description": "the name of the domain in which the virtual machine exists",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "Os type ID of the virtual machine",
- "name": "guestosid",
- "type": "string"
- },
- {
- "description": "user generated name. The name of the virtual machine is returned if no displayname exists.",
- "name": "displayname",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the ID of the service offering of the virtual machine",
- "name": "serviceofferingid",
+ "description": "Guest vm Boot Type",
+ "name": "boottype",
"type": "string"
},
{
@@ -7735,24 +7434,325 @@
"type": "string"
},
{
+ "description": "user generated name. The name of the virtual machine is returned if no displayname exists.",
+ "name": "displayname",
+ "type": "string"
+ },
+ {
+ "description": "the write (bytes) of disk on the vm",
+ "name": "diskkbswrite",
+ "type": "long"
+ },
+ {
+ "description": "the ID of the ISO attached to the virtual machine",
+ "name": "isoid",
+ "type": "string"
+ },
+ {
+ "description": "the speed of each cpu",
+ "name": "cpuspeed",
+ "type": "integer"
+ },
+ {
+ "description": "true if high-availability is enabled, false otherwise",
+ "name": "haenable",
+ "type": "boolean"
+ },
+ {
+ "description": "the amount of the vm's CPU currently used",
+ "name": "cpuused",
+ "type": "string"
+ },
+ {
+ "description": "the name of the availability zone for the virtual machine",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the vm",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the read (io) of disk on the vm",
+ "name": "diskioread",
+ "type": "long"
+ },
+ {
+ "description": "the ID of the disk offering of the virtual machine",
+ "name": "diskofferingid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.",
+ "name": "templateid",
+ "type": "string"
+ },
+ {
+ "description": "the write (io) of disk on the vm",
+ "name": "diskiowrite",
+ "type": "long"
+ },
+ {
+ "description": "OS type id of the vm",
+ "name": "ostypeid",
+ "type": "string"
+ },
+ {
+ "description": "the list of resource tags associated",
+ "name": "tags",
+ "response": [
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "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 account associated with the virtual machine",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the outgoing network traffic on the host",
+ "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": "the ID of the host for the virtual machine",
"name": "hostid",
"type": "string"
},
{
- "description": "the ID of the availablility zone for the virtual machine",
- "name": "zoneid",
+ "description": "device ID of the root volume",
+ "name": "rootdeviceid",
+ "type": "long"
+ },
+ {
+ "description": "the list of nics associated with vm",
+ "name": "nic",
+ "response": [
+ {
+ "description": "the gateway of the nic",
+ "name": "gateway",
+ "type": "string"
+ },
+ {
+ "description": "Id of the vm to which the nic belongs",
+ "name": "virtualmachineid",
+ "type": "string"
+ },
+ {
+ "description": "the Secondary ipv4 addr of nic",
+ "name": "secondaryip",
+ "type": "list"
+ },
+ {
+ "description": "the ID of the corresponding network",
+ "name": "networkid",
+ "type": "string"
+ },
+ {
+ "description": "the type of the nic",
+ "name": "type",
+ "type": "string"
+ },
+ {
+ "description": "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": "macaddress",
+ "type": "string"
+ },
+ {
+ "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise",
+ "name": "nsxlogicalswitchport",
+ "type": "string"
+ },
+ {
+ "description": "the isolation uri of the nic",
+ "name": "isolationuri",
+ "type": "string"
+ },
+ {
+ "description": "the isolated private VLAN type if available",
+ "name": "isolatedpvlantype",
+ "type": "string"
+ },
+ {
+ "description": "Id of the NSX Logical Switch (if NSX based), null otherwise",
+ "name": "nsxlogicalswitch",
+ "type": "string"
+ },
+ {
+ "description": "the netmask of the nic",
+ "name": "netmask",
+ "type": "string"
+ },
+ {
+ "description": "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": "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 ip address of the nic",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "the isolated private VLAN if available",
+ "name": "isolatedpvlan",
+ "type": "integer"
+ },
+ {
+ "description": "Type of adapter if available",
+ "name": "adaptertype",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the nic",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the gateway of IPv6 network",
+ "name": "ip6gateway",
+ "type": "string"
+ },
+ {
+ "description": "the broadcast uri of the nic",
+ "name": "broadcasturi",
+ "type": "string"
+ },
+ {
+ "description": "the cidr of IPv6 network",
+ "name": "ip6cidr",
+ "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"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "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": "OS name of the vm",
+ "name": "osdisplayname",
"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": "the incoming network traffic on the vm",
- "name": "networkkbsread",
- "type": "long"
+ "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": "public IP address id associated with vm via Static nat rule",
+ "name": "publicip",
+ "type": "string"
}
],
"since": "3.0.0"
@@ -7763,6 +7763,13 @@
"name": "deleteEvents",
"params": [
{
+ "description": "start date range to delete events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")",
+ "length": 255,
+ "name": "startdate",
+ "required": false,
+ "type": "date"
+ },
+ {
"description": "the IDs of the events",
"length": 255,
"name": "ids",
@@ -7771,13 +7778,6 @@
"type": "list"
},
{
- "description": "delete by event type",
- "length": 255,
- "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",
@@ -7785,19 +7785,14 @@
"type": "date"
},
{
- "description": "start date range to delete events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")",
+ "description": "delete by event type",
"length": 255,
- "name": "startdate",
+ "name": "type",
"required": false,
- "type": "date"
+ "type": "string"
}
],
"response": [
- {
- "description": "true if operation is executed successfully",
- "name": "success",
- "type": "boolean"
- },
{},
{
"description": "the UUID of the latest async job acting on this object",
@@ -7805,6 +7800,11 @@
"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"
@@ -7833,102 +7833,26 @@
],
"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": "List ucs blades",
- "isasync": false,
- "name": "listUcsBlades",
- "params": [
- {
- "description": "",
- "length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
- },
- {
- "description": "ucs manager id",
- "length": 255,
- "name": "ucsmanagerid",
- "related": "listUcsManagers,addUcsManager",
- "required": true,
- "type": "uuid"
- },
- {
- "description": "",
- "length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
- },
- {
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
- }
- ],
- "related": "associateUcsProfileToBlade",
- "response": [
- {
- "description": "ucs blade id",
- "name": "id",
- "type": "string"
- },
+ {},
+ {},
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
{
- "description": "ucs manager id",
- "name": "ucsmanagerid",
- "type": "string"
- },
- {},
- {},
- {
- "description": "associated ucs profile dn",
- "name": "profiledn",
- "type": "string"
- },
- {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
- },
- {
- "description": "ucs blade dn",
- "name": "bladedn",
- "type": "string"
- },
- {
- "description": "cloudstack host id this blade associates to",
- "name": "hostid",
- "type": "string"
}
]
},
@@ -7946,27 +7870,103 @@
}
],
"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": "List ucs blades",
+ "isasync": false,
+ "name": "listUcsBlades",
+ "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,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "ucs manager id",
+ "length": 255,
+ "name": "ucsmanagerid",
+ "related": "listUcsManagers,addUcsManager",
+ "required": true,
+ "type": "uuid"
+ }
+ ],
+ "related": "associateUcsProfileToBlade",
+ "response": [
+ {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
{
+ "description": "associated ucs profile dn",
+ "name": "profiledn",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "ucs blade id",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "cloudstack host id this blade associates to",
+ "name": "hostid",
+ "type": "string"
+ },
+ {
+ "description": "ucs manager id",
+ "name": "ucsmanagerid",
+ "type": "string"
+ },
+ {
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
+ {
+ "description": "ucs blade dn",
+ "name": "bladedn",
+ "type": "string"
+ },
{}
]
},
@@ -7986,21 +7986,21 @@
"related": "getVolumeiScsiName",
"response": [
{
- "description": "Volume iSCSI Name",
- "name": "volumeiScsiName",
- "type": "string"
- },
- {},
- {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
{
+ "description": "Volume iSCSI Name",
+ "name": "volumeiScsiName",
+ "type": "string"
+ },
+ {
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
+ {},
{}
]
},
@@ -8010,35 +8010,29 @@
"name": "deleteIso",
"params": [
{
- "description": "the ID of the zone of the ISO file. If not specified, the ISO will be deleted from all the zones",
- "length": 255,
- "name": "zoneid",
- "related": "createZone,updateZone,listZones,listZones",
- "required": false,
- "type": "uuid"
- },
- {
"description": "the ID of the ISO file",
"length": 255,
"name": "id",
"related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos",
"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,
+ "name": "zoneid",
+ "related": "createZone,updateZone,listZones,listZones",
+ "required": false,
+ "type": "uuid"
}
],
"response": [
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {},
- {},
- {
"description": "true if operation is executed successfully",
"name": "success",
"type": "boolean"
},
+ {},
{
"description": "any text associated with the success or failure",
"name": "displaytext",
@@ -8048,7 +8042,13 @@
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
- }
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {}
]
},
{
@@ -8066,6 +8066,13 @@
}
],
"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",
@@ -8076,18 +8083,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"
- },
- {}
+ }
]
},
{
@@ -8096,6 +8096,13 @@
"name": "updateHost",
"params": [
{
+ "description": "the new uri for the secondary storage: nfs://host/path",
+ "length": 255,
+ "name": "url",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "the id of Os category to update the host with",
"length": 255,
"name": "oscategoryid",
@@ -8104,21 +8111,6 @@
"type": "uuid"
},
{
- "description": "Change resource state of host, valid values are [Enable, Disable]. Operation may failed if host in states not allowing Enable/Disable",
- "length": 255,
- "name": "allocationstate",
- "required": false,
- "type": "string"
- },
- {
- "description": "Change the name of host",
- "length": 255,
- "name": "name",
- "required": false,
- "since": "4.15",
- "type": "string"
- },
- {
"description": "Add an annotation to this host",
"length": 255,
"name": "annotation",
@@ -8127,13 +8119,6 @@
"type": "string"
},
{
- "description": "the new uri for the secondary storage: nfs://host/path",
- "length": 255,
- "name": "url",
- "required": false,
- "type": "string"
- },
- {
"description": "the ID of the host to update",
"length": 255,
"name": "id",
@@ -8142,6 +8127,21 @@
"type": "uuid"
},
{
+ "description": "Change the name of host",
+ "length": 255,
+ "name": "name",
+ "required": false,
+ "since": "4.15",
+ "type": "string"
+ },
+ {
+ "description": "Change resource state of host, valid values are [Enable, Disable]. Operation may failed if host in states not allowing Enable/Disable",
+ "length": 255,
+ "name": "allocationstate",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "list of tags to be added to the host",
"length": 255,
"name": "hosttags",
@@ -8152,18 +8152,114 @@
"related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost,listExternalLoadBalancers",
"response": [
{
+ "description": "the CPU number of the host",
+ "name": "cpunumber",
+ "type": "integer"
+ },
+ {
+ "description": "the host HA information information",
+ "name": "hostha",
+ "type": "hostharesponse"
+ },
+ {
+ "description": "the date and time the host was last pinged",
+ "name": "lastpinged",
+ "type": "date"
+ },
+ {
+ "description": "the number of CPU sockets on the host",
+ "name": "cpusockets",
+ "type": "integer"
+ },
+ {
+ "description": "the date and time the host was removed",
+ "name": "removed",
+ "type": "date"
+ },
+ {
+ "description": "the CPU speed of the host",
+ "name": "cpuspeed",
+ "type": "long"
+ },
+ {
+ "description": "the OS category ID of the host",
+ "name": "oscategoryid",
+ "type": "string"
+ },
+ {
+ "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise",
+ "name": "suitableformigration",
+ "type": "boolean"
+ },
+ {
+ "description": "the cluster name of the host",
+ "name": "clustername",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor",
+ "name": "cpuwithoverprovisioning",
+ "type": "string"
+ },
+ {
+ "description": "the total disk size of the host",
+ "name": "disksizetotal",
+ "type": "long"
+ },
+ {},
+ {
+ "description": "the cpu average load on the host",
+ "name": "cpuloadaverage",
+ "type": "double"
+ },
+ {
"description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise",
"name": "hasenoughcapacity",
"type": "boolean"
},
{
- "description": "capabilities of the host",
- "name": "capabilities",
+ "description": "the management server ID of the host",
+ "name": "managementserverid",
"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": "true if the host is disconnected. False otherwise.",
+ "name": "disconnected",
+ "type": "date"
+ },
+ {
+ "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": "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 UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
@@ -8172,13 +8268,104 @@
"type": "status"
},
{
- "description": "the host HA information information",
- "name": "hostha",
- "type": "hostharesponse"
+ "description": "the amount of the host's memory currently allocated in percentage",
+ "name": "memoryallocatedpercentage",
+ "type": "string"
},
{
- "description": "the management server ID of the host",
- "name": "managementserverid",
+ "description": "the IP address of the host",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "the date and time the host was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the amount of the host's memory currently allocated in bytes",
+ "name": "memoryallocatedbytes",
+ "type": "long"
+ },
+ {
+ "description": "the last time this host was annotated",
+ "name": "lastannotated",
+ "type": "date"
+ },
+ {
+ "description": "capabilities of the host",
+ "name": "capabilities",
+ "type": "string"
+ },
+ {
+ "description": "the host hypervisor",
+ "name": "hypervisor",
+ "type": "hypervisortype"
+ },
+ {},
+ {
+ "description": "the amount of the host's CPU currently allocated in percentage",
+ "name": "cpuallocatedpercentage",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the host's CPU currently allocated in MHz",
+ "name": "cpuallocatedvalue",
+ "type": "long"
+ },
+ {
+ "description": "the incoming network traffic on the host",
+ "name": "networkkbsread",
+ "type": "long"
+ },
+ {
+ "description": "the host out-of-band management information",
+ "name": "outofbandmanagement",
+ "type": "outofbandmanagementresponse"
+ },
+ {
+ "description": "the host type",
+ "name": "type",
+ "type": "type"
+ },
+ {
+ "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 amount of the host's memory currently allocated",
+ "name": "memoryallocated",
+ "type": "long"
+ },
+ {
+ "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise",
+ "name": "hahost",
+ "type": "boolean"
+ },
+ {
+ "description": "the hypervisor version",
+ "name": "hypervisorversion",
+ "type": "string"
+ },
+ {
+ "description": "the host version",
+ "name": "version",
+ "type": "string"
+ },
+ {
+ "description": "the Zone name of the host",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "comma-separated list of tags for the host",
+ "name": "hosttags",
"type": "string"
},
{
@@ -8187,18 +8374,8 @@
"type": "boolean"
},
{
- "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor",
- "name": "cpuallocatedwithoverprovisioning",
- "type": "string"
- },
- {
- "description": "the ID of the host",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the cluster name of the host",
- "name": "clustername",
+ "description": "the amount of the host's CPU currently allocated",
+ "name": "cpuallocated",
"type": "string"
},
{
@@ -8206,20 +8383,35 @@
"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 Y resolution per display",
+ "name": "maxresolutiony",
+ "type": "long"
+ },
+ {
+ "description": "Video RAM for this vGPU type",
+ "name": "videoram",
+ "type": "long"
+ },
+ {
"description": "Maximum displays per user",
"name": "maxheads",
"type": "long"
},
{
+ "description": "Maximum no. of vgpu per gpu card (pgpu)",
+ "name": "maxvgpuperpgpu",
+ "type": "long"
+ },
+ {
+ "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type",
+ "name": "remainingcapacity",
+ "type": "long"
+ },
+ {
"description": "Maximum X resolution per display",
"name": "maxresolutionx",
"type": "long"
@@ -8230,130 +8422,39 @@
"type": "string"
},
{
- "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",
- "type": "long"
- },
- {
- "description": "Maximum no. of vgpu per gpu card (pgpu)",
- "name": "maxvgpuperpgpu",
- "type": "long"
- },
- {
"description": "Maximum vgpu can be created with this vgpu type on the given gpu group",
"name": "maxcapacity",
"type": "long"
- },
- {
- "description": "Maximum Y resolution per display",
- "name": "maxresolutiony",
- "type": "long"
}
],
"type": "list"
+ },
+ {
+ "description": "GPU cards present in the host",
+ "name": "gpugroupname",
+ "type": "string"
}
],
"type": "list"
},
{
- "description": "the OS category name of the host",
- "name": "oscategoryname",
- "type": "string"
- },
- {
- "description": "the Zone name of the host",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "the amount of the host's memory currently used",
- "name": "memoryused",
- "type": "long"
- },
- {
- "description": "the host out-of-band management information",
- "name": "outofbandmanagement",
- "type": "outofbandmanagementresponse"
- },
- {
"description": "Host details in key/value pairs.",
"name": "details",
"type": "map"
},
{
- "description": "the host's currently allocated disk size",
- "name": "disksizeallocated",
- "type": "long"
- },
- {
- "description": "the date and time the host was removed",
- "name": "removed",
- "type": "date"
- },
- {
- "description": "the hypervisor version",
- "name": "hypervisorversion",
+ "description": "the Pod ID of the host",
+ "name": "podid",
"type": "string"
},
{
- "description": "the date and time the host was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the host version",
- "name": "version",
+ "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor",
+ "name": "cpuallocatedwithoverprovisioning",
"type": "string"
},
{
- "description": "the amount of the host's CPU currently allocated in MHz",
- "name": "cpuallocatedvalue",
- "type": "long"
- },
- {
- "description": "the OS category ID of the host",
- "name": "oscategoryid",
- "type": "string"
- },
- {},
- {
- "description": "events available for the host",
- "name": "events",
- "type": "string"
- },
- {
- "description": "the amount of the host's memory currently allocated in percentage",
- "name": "memoryallocatedpercentage",
- "type": "string"
- },
- {
- "description": "the amount of the host's CPU currently allocated",
- "name": "cpuallocated",
- "type": "string"
- },
- {
- "description": "the last annotation set on this host by an admin",
- "name": "annotation",
- "type": "string"
- },
- {
- "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise",
- "name": "hahost",
- "type": "boolean"
- },
- {
- "description": "the CPU speed of the host",
- "name": "cpuspeed",
- "type": "long"
- },
- {
- "description": "the amount of the host's memory currently allocated",
- "name": "memoryallocated",
+ "description": "the outgoing network traffic on the host",
+ "name": "networkkbswrite",
"type": "long"
},
{
@@ -8362,33 +8463,18 @@
"type": "boolean"
},
{
- "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning",
- "name": "memorytotal",
- "type": "long"
- },
- {
- "description": "the outgoing network traffic on the host",
- "name": "networkkbswrite",
- "type": "long"
- },
- {
- "description": "the host type",
- "name": "type",
- "type": "type"
- },
- {
- "description": "the admin that annotated this host",
- "name": "username",
+ "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 amount of the host's memory currently used",
+ "name": "memoryused",
+ "type": "long"
},
{
- "description": "the Pod name of the host",
- "name": "podname",
+ "description": "the ID of the host",
+ "name": "id",
"type": "string"
},
{
@@ -8397,119 +8483,33 @@
"type": "string"
},
{
+ "description": "the cluster type of the cluster that host belongs to",
+ "name": "clustertype",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the host's CPU currently used",
+ "name": "cpuused",
+ "type": "string"
+ },
+ {
+ "description": "the admin that annotated this host",
+ "name": "username",
+ "type": "string"
+ },
+ {
"description": "the cluster ID of the host",
"name": "clusterid",
"type": "string"
},
{
- "description": "the total disk size of the host",
- "name": "disksizetotal",
- "type": "long"
- },
- {
- "description": "true if the host is disconnected. False otherwise.",
- "name": "disconnected",
- "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 amount of the host's memory after applying the mem.overprovisioning.factor",
- "name": "memorywithoverprovisioning",
- "type": "string"
- },
- {
- "description": "the amount of the host's memory currently allocated in bytes",
- "name": "memoryallocatedbytes",
- "type": "long"
- },
- {
- "description": "the Pod ID of the host",
- "name": "podid",
- "type": "string"
- },
- {
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "the amount of the host's CPU currently allocated in percentage",
- "name": "cpuallocatedpercentage",
- "type": "string"
- },
- {
- "description": "the IP address of the host",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the incoming network traffic on the host",
- "name": "networkkbsread",
- "type": "long"
- },
- {
- "description": "the CPU number of the host",
- "name": "cpunumber",
- "type": "integer"
- },
- {
- "description": "comma-separated list of tags for the host",
- "name": "hosttags",
- "type": "string"
- },
- {
- "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 host hypervisor",
- "name": "hypervisor",
- "type": "hypervisortype"
- },
- {
- "description": "the date and time the host was last pinged",
- "name": "lastpinged",
- "type": "date"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {},
- {
"description": "the name of the host",
"name": "name",
"type": "string"
},
{
- "description": "the number of CPU sockets on the host",
- "name": "cpusockets",
- "type": "integer"
- },
- {
- "description": "the last time this host was annotated",
- "name": "lastannotated",
- "type": "date"
- },
- {
- "description": "the cluster type of the cluster that host belongs to",
- "name": "clustertype",
+ "description": "events available for the host",
+ "name": "events",
"type": "string"
}
]
@@ -8520,28 +8520,6 @@
"name": "createEgressFirewallRule",
"params": [
{
- "description": "the cidr list to forward traffic from. Multiple entries must be separated by a single comma character (,).",
- "length": 255,
- "name": "cidrlist",
- "required": false,
- "type": "list"
- },
- {
- "description": "type of firewallrule: system/user",
- "length": 255,
- "name": "type",
- "required": false,
- "type": "string"
- },
- {
- "description": "the network id of the port forwarding rule",
- "length": 255,
- "name": "networkid",
- "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks",
- "required": true,
- "type": "uuid"
- },
- {
"description": "the cidr list to forward traffic to. Multiple entries must be separated by a single comma character (,).",
"length": 255,
"name": "destcidrlist",
@@ -8557,13 +8535,6 @@
"type": "boolean"
},
{
- "description": "type of the icmp message being sent",
- "length": 255,
- "name": "icmptype",
- "required": false,
- "type": "integer"
- },
- {
"description": "the ending port of firewall rule",
"length": 255,
"name": "endport",
@@ -8571,136 +8542,71 @@
"type": "integer"
},
{
- "description": "error code for this icmp message",
- "length": 255,
- "name": "icmpcode",
- "required": false,
- "type": "integer"
- },
- {
- "description": "the starting port of firewall rule",
- "length": 255,
- "name": "startport",
- "required": false,
- "type": "integer"
- },
- {
"description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.",
"length": 255,
"name": "protocol",
"required": true,
"type": "string"
+ },
+ {
+ "description": "the cidr list to forward traffic from. Multiple entries must be separated by a single comma character (,).",
+ "length": 255,
+ "name": "cidrlist",
+ "required": false,
+ "type": "list"
+ },
+ {
+ "description": "the network id of the port forwarding rule",
+ "length": 255,
+ "name": "networkid",
+ "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks",
+ "required": true,
+ "type": "uuid"
+ },
+ {
+ "description": "the starting port of firewall rule",
+ "length": 255,
+ "name": "startport",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "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,
+ "name": "icmpcode",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "type of firewallrule: system/user",
+ "length": 255,
+ "name": "type",
+ "required": false,
+ "type": "string"
}
],
"related": "createFirewallRule,listEgressFirewallRules,listFirewallRules,updateEgressFirewallRule",
"response": [
{
- "description": "the protocol of the firewall rule",
- "name": "protocol",
- "type": "string"
- },
- {
- "description": "error code for this icmp message",
- "name": "icmpcode",
- "type": "integer"
- },
- {},
- {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
{
- "description": "type of the icmp message being sent",
- "name": "icmptype",
- "type": "integer"
- },
- {
- "description": "the list of resource tags associated with the rule",
- "name": "tags",
- "response": [
- {
- "description": "resource type",
- "name": "resourcetype",
- "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 key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- }
- ],
- "type": "list"
- },
- {
- "description": "is rule for display to the regular user",
- "name": "fordisplay",
- "type": "boolean"
- },
- {
- "description": "the public ip address for the firewall rule",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).",
- "name": "destcidrlist",
- "type": "string"
- },
- {
"description": "the starting port of firewall rule's port range",
"name": "startport",
"type": "integer"
},
- {},
{
- "description": "the public ip address id for the firewall rule",
- "name": "ipaddressid",
- "type": "string"
- },
- {
- "description": "the ID of the firewall rule",
- "name": "id",
+ "description": "the state of the rule",
+ "name": "state",
"type": "string"
},
{
@@ -8709,24 +8615,118 @@
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
+ "description": "the ending port of firewall rule's port range",
+ "name": "endport",
"type": "integer"
},
+ {},
+ {
+ "description": "is rule for display to the regular user",
+ "name": "fordisplay",
+ "type": "boolean"
+ },
+ {
+ "description": "error code for this icmp message",
+ "name": "icmpcode",
+ "type": "integer"
+ },
+ {
+ "description": "the protocol of the firewall rule",
+ "name": "protocol",
+ "type": "string"
+ },
{
"description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).",
"name": "cidrlist",
"type": "string"
},
{
- "description": "the ending port of firewall rule's port range",
- "name": "endport",
+ "description": "type of the icmp message being sent",
+ "name": "icmptype",
"type": "integer"
},
{
- "description": "the state of the rule",
- "name": "state",
+ "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 ID of the firewall rule",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the list of resource tags associated with the rule",
+ "name": "tags",
+ "response": [
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "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 id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ }
+ ],
+ "type": "list"
+ },
+ {},
+ {
+ "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).",
+ "name": "destcidrlist",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
}
]
},
@@ -8736,65 +8736,6 @@
"name": "listVPCOfferings",
"params": [
{
- "description": "list VPC offerings by state",
- "length": 255,
- "name": "state",
- "required": false,
- "type": "string"
- },
- {
- "description": "list VPC offerings supporting certain services",
- "length": 255,
- "name": "supportedservices",
- "required": false,
- "type": "list"
- },
- {
- "description": "list VPC offerings by id",
- "length": 255,
- "name": "id",
- "related": "updateVPCOffering,listVPCOfferings",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "list VPC offerings by name",
- "length": 255,
- "name": "name",
- "required": false,
- "type": "string"
- },
- {
- "description": "true if need to list only default VPC offerings. Default value is false",
- "length": 255,
- "name": "isdefault",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "id of zone disk offering is associated with",
- "length": 255,
- "name": "zoneid",
- "related": "createZone,updateZone,listZones,listZones",
- "required": false,
- "since": "4.13",
- "type": "uuid"
- },
- {
- "description": "list VPC offerings by display text",
- "length": 255,
- "name": "displaytext",
- "required": false,
- "type": "string"
- },
- {
- "description": "",
- "length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
- },
- {
"description": "List by keyword",
"length": 255,
"name": "keyword",
@@ -8807,24 +8748,79 @@
"name": "pagesize",
"required": false,
"type": "integer"
+ },
+ {
+ "description": "list VPC offerings by display text",
+ "length": 255,
+ "name": "displaytext",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "list VPC offerings by state",
+ "length": 255,
+ "name": "state",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "id of zone disk offering is associated with",
+ "length": 255,
+ "name": "zoneid",
+ "related": "createZone,updateZone,listZones,listZones",
+ "required": false,
+ "since": "4.13",
+ "type": "uuid"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "list VPC offerings by name",
+ "length": 255,
+ "name": "name",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "list VPC offerings by id",
+ "length": 255,
+ "name": "id",
+ "related": "updateVPCOffering,listVPCOfferings",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "list VPC offerings supporting certain services",
+ "length": 255,
+ "name": "supportedservices",
+ "required": false,
+ "type": "list"
+ },
+ {
+ "description": "true if need to list only default VPC offerings. Default value is false",
+ "length": 255,
+ "name": "isdefault",
+ "required": false,
+ "type": "boolean"
}
],
"related": "updateVPCOffering",
"response": [
+ {},
{
- "description": "the name of the vpc offering",
- "name": "name",
+ "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
+ "name": "domain",
"type": "string"
},
{
- "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
- "name": "domainid",
- "type": "string"
+ "description": " indicates if the vpc offering supports distributed router for one-hop forwarding",
+ "name": "distributedvpcrouter",
+ "type": "boolean"
},
{
"description": "true if vpc offering is default, false otherwise",
@@ -8832,19 +8828,9 @@
"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 UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "state of the vpc offering. Can be Disabled/Enabled",
- "name": "state",
- "type": "string"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
{
"description": "the date this vpc offering was created",
@@ -8857,46 +8843,35 @@
"type": "string"
},
{
- "description": " indicates if the vpc offering supports distributed router for one-hop forwarding",
- "name": "distributedvpcrouter",
- "type": "boolean"
- },
- {},
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
"description": "an alternate display text of the vpc offering.",
"name": "displaytext",
"type": "string"
},
- {
- "description": " indicated if the offering can support region level vpc",
- "name": "supportsregionLevelvpc",
- "type": "boolean"
- },
- {
- "description": "the id of the vpc offering",
- "name": "id",
- "type": "string"
- },
{},
{
"description": "the 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 destination physical network",
+ "name": "destinationphysicalnetworkid",
+ "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"
@@ -8907,26 +8882,11 @@
"type": "string"
},
{
- "description": "the physical network this belongs to",
- "name": "physicalnetworkid",
- "type": "string"
- },
- {
"description": "uuid of the network provider",
"name": "id",
"type": "string"
},
{
- "description": "the destination physical network",
- "name": "destinationphysicalnetworkid",
- "type": "string"
- },
- {
- "description": "services for this provider",
- "name": "servicelist",
- "type": "list"
- },
- {
"description": "the provider name",
"name": "name",
"type": "string"
@@ -8935,17 +8895,22 @@
"type": "list"
},
{
+ "description": "the service name",
+ "name": "name",
+ "type": "string"
+ },
+ {
"description": "the list of capabilities",
"name": "capability",
"response": [
{
- "description": "the capability value",
- "name": "value",
+ "description": "the capability name",
+ "name": "name",
"type": "string"
},
{
- "description": "the capability name",
- "name": "name",
+ "description": "the capability value",
+ "name": "value",
"type": "string"
},
{
@@ -8958,6 +8923,41 @@
}
],
"type": "list"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the vpc offering",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "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 ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": " indicated if the offering can support region level vpc",
+ "name": "supportsregionLevelvpc",
+ "type": "boolean"
+ },
+ {
+ "description": "state of the vpc offering. Can be Disabled/Enabled",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "the id of the vpc offering",
+ "name": "id",
+ "type": "string"
}
]
},
@@ -8976,22 +8976,22 @@
],
"related": "",
"response": [
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
{},
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
{},
{
"description": "SolidFire Volume Size Including Hypervisor Snapshot Reserve",
"name": "solidFireVolumeSize",
"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"
}
]
},
@@ -9001,9 +9001,9 @@
"name": "uploadVolume",
"params": [
{
- "description": "an optional accountName. Must be used with domainId.",
+ "description": "Image store uuid",
"length": 255,
- "name": "account",
+ "name": "imagestoreuuid",
"required": false,
"type": "string"
},
@@ -9016,11 +9016,20 @@
"type": "uuid"
},
{
- "description": "the format for the volume. Possible values include QCOW2, OVA, and VHD.",
+ "description": "an optional domainId. If the account parameter is used, domainId must also be used.",
"length": 255,
- "name": "format",
- "required": true,
- "type": "string"
+ "name": "domainid",
+ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "Upload volume for the project",
+ "length": 255,
+ "name": "projectid",
+ "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject",
+ "required": false,
+ "type": "uuid"
},
{
"description": "the name of the volume",
@@ -9030,6 +9039,20 @@
"type": "string"
},
{
+ "description": "the URL of where the volume is hosted. Possible URL include http:// and https://",
+ "length": 2048,
+ "name": "url",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "an optional accountName. Must be used with domainId.",
+ "length": 255,
+ "name": "account",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "the ID of the zone the volume is to be hosted on",
"length": 255,
"name": "zoneid",
@@ -9038,53 +9061,30 @@
"type": "uuid"
},
{
- "description": "the URL of where the volume is hosted. Possible URL include http:// and https://",
- "length": 2048,
- "name": "url",
+ "description": "the format for the volume. Possible values include QCOW2, OVA, and VHD.",
+ "length": 255,
+ "name": "format",
"required": true,
"type": "string"
},
{
- "description": "an optional domainId. If the account parameter is used, domainId must also be used.",
- "length": 255,
- "name": "domainid",
- "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
- "required": false,
- "type": "uuid"
- },
- {
"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 \"{<algorithm>}\", not including the double quotes. In this <algorithm> is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.",
"length": 255,
"name": "checksum",
"required": false,
"type": "string"
- },
- {
- "description": "Image store uuid",
- "length": 255,
- "name": "imagestoreuuid",
- "required": false,
- "type": "string"
- },
- {
- "description": "Upload volume for the project",
- "length": 255,
- "name": "projectid",
- "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject",
- "required": false,
- "type": "uuid"
}
],
"related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume",
"response": [
{
- "description": "the state of the disk volume",
- "name": "state",
- "type": "string"
+ "description": "the read (bytes) of disk on the vm",
+ "name": "diskkbsread",
+ "type": "long"
},
{
- "description": "the display text of the service offering for root disk",
- "name": "serviceofferingdisplaytext",
+ "description": "the chain info of the volume",
+ "name": "chaininfo",
"type": "string"
},
{
@@ -9093,48 +9093,23 @@
"type": "string"
},
{
- "description": "the name of the template for the virtual machine",
- "name": "templatename",
+ "description": "the domain associated with the disk volume",
+ "name": "domain",
"type": "string"
},
{
- "description": "the account associated with the disk volume",
- "name": "account",
- "type": "string"
- },
- {
- "description": "name of the availability zone",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "name of the primary storage hosting the disk volume",
- "name": "storage",
- "type": "string"
- },
- {
- "description": "the name of the ISO attached to the virtual machine",
- "name": "isoname",
- "type": "string"
- },
- {
- "description": "the write (io) of disk on the vm",
- "name": "diskiowrite",
- "type": "long"
- },
- {
- "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": "provisioning type used to create volumes.",
- "name": "provisioningtype",
+ "description": "the bytes allocated",
+ "name": "physicalsize",
+ "type": "long"
+ },
+ {
+ "description": "the display text of the service offering for root disk",
+ "name": "serviceofferingdisplaytext",
"type": "string"
},
{
@@ -9143,6 +9118,26 @@
"type": "string"
},
{
+ "description": "ID of the service offering for root disk",
+ "name": "serviceofferingid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the disk volume",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "name of the disk volume",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the vpn",
+ "name": "project",
+ "type": "string"
+ },
+ {
"description": "true if storage snapshot is supported for the volume, false otherwise",
"name": "supportsstoragesnapshot",
"type": "boolean"
@@ -9153,24 +9148,9 @@
"type": "string"
},
{
- "description": "the bytes allocated",
- "name": "physicalsize",
- "type": "long"
- },
- {
- "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": "min iops of the disk volume",
- "name": "miniops",
- "type": "long"
+ "description": " an alternate display text of the template for the virtual machine",
+ "name": "templatedisplaytext",
+ "type": "string"
},
{
"description": "the bytes actually consumed on disk",
@@ -9178,63 +9158,23 @@
"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": "cluster id of the volume",
+ "name": "clusterid",
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "name of the disk offering",
- "name": "diskofferingname",
+ "description": "provisioning type used to create volumes.",
+ "name": "provisioningtype",
"type": "string"
},
{
- "description": "name of the service offering for root disk",
- "name": "serviceofferingname",
- "type": "string"
- },
- {
- "description": "the chain info of the volume",
- "name": "chaininfo",
- "type": "string"
- },
- {
- "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.",
- "name": "deviceid",
- "type": "long"
- },
- {
"description": "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": "ID of the availability zone",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "io requests write rate of the disk volume per the disk offering",
- "name": "diskIopsWriteRate",
- "type": "long"
- },
- {
- "description": "an optional field whether to the display the volume to the end user or not.",
- "name": "displayvolume",
+ "description": "true if the volume is extractable, false otherwise",
+ "name": "isextractable",
"type": "boolean"
},
{
@@ -9243,23 +9183,18 @@
"type": "string"
},
{
- "description": "state of the virtual machine",
- "name": "vmstate",
+ "description": "the date the disk volume was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "ID of the disk volume",
+ "name": "id",
"type": "string"
},
{
- "description": "max iops of the disk volume",
- "name": "maxiops",
- "type": "long"
- },
- {
- "description": "the ID of the domain associated with the disk volume",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "pod id of the volume",
- "name": "podid",
+ "description": "ID of the disk offering",
+ "name": "diskofferingid",
"type": "string"
},
{
@@ -9268,8 +9203,13 @@
"type": "date"
},
{
- "description": "the path of the volume",
- "name": "path",
+ "description": "need quiesce vm or not when taking snapshot",
+ "name": "quiescevm",
+ "type": "boolean"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
@@ -9278,10 +9218,41 @@
"type": "long"
},
{
- "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": "io requests read rate of the disk volume per the disk offering",
+ "name": "diskIopsReadRate",
+ "type": "long"
+ },
+ {
+ "description": "max iops of the disk volume",
+ "name": "maxiops",
+ "type": "long"
+ },
+ {
+ "description": "the state of the disk volume",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "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 template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.",
+ "name": "templateid",
+ "type": "string"
+ },
+ {
+ "description": "bytes write rate of the disk volume",
+ "name": "diskBytesWriteRate",
+ "type": "long"
+ },
{
"description": "type of the disk volume (ROOT or DATADISK)",
"name": "type",
@@ -9293,71 +9264,35 @@
"type": "string"
},
{
- "description": "the display text of the disk offering",
- "name": "diskofferingdisplaytext",
- "type": "string"
- },
- {
- "description": "display name of the virtual machine",
- "name": "vmdisplayname",
- "type": "string"
- },
- {
- "description": "bytes write rate of the disk volume",
- "name": "diskBytesWriteRate",
- "type": "long"
- },
- {
- "description": "need quiesce vm or not when taking snapshot",
- "name": "quiescevm",
- "type": "boolean"
- },
- {
- "description": "the ID of the ISO attached to the virtual machine",
- "name": "isoid",
- "type": "string"
- },
- {
- "description": "ID of the disk offering",
- "name": "diskofferingid",
- "type": "string"
- },
- {
- "description": "the project name of the vpn",
- "name": "project",
- "type": "string"
- },
- {
- "description": "an alternate display text of the ISO attached to the virtual machine",
- "name": "isodisplaytext",
- "type": "string"
- },
- {},
- {
- "description": "ID of the service offering for root disk",
- "name": "serviceofferingid",
- "type": "string"
- },
- {
- "description": "the read (bytes) of disk on the vm",
- "name": "diskkbsread",
- "type": "long"
- },
- {
- "description": "id of the primary storage hosting the disk volume; returned to admin user only",
- "name": "storageid",
- "type": "string"
- },
- {
"description": "the list of resource tags associated",
"name": "tags",
"response": [
{
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
"description": "resource type",
"name": "resourcetype",
"type": "string"
},
{
+ "description": "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"
@@ -9368,56 +9303,36 @@
"type": "string"
},
{
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
"description": "the domain associated with the tag",
"name": "domain",
"type": "string"
},
{
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
"description": "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"
}
],
"type": "set"
},
{
- "description": "the disk utilization",
- "name": "utilization",
+ "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": "an alternate display text of the ISO attached to the virtual machine",
+ "name": "isodisplaytext",
+ "type": "string"
},
{
- "description": "ID of the disk volume",
- "name": "id",
+ "description": "pod id of the volume",
+ "name": "podid",
"type": "string"
},
{
@@ -9426,39 +9341,124 @@
"type": "long"
},
{
- "description": "io requests read rate of the disk volume per the disk offering",
- "name": "diskIopsReadRate",
- "type": "long"
- },
- {
- "description": "cluster id of the volume",
- "name": "clusterid",
+ "description": "the ID of the ISO attached to the virtual machine",
+ "name": "isoid",
"type": "string"
},
{
- "description": " an alternate display text of the template for the virtual machine",
- "name": "templatedisplaytext",
- "type": "string"
- },
- {
- "description": "shared or local storage",
- "name": "storagetype",
- "type": "string"
- },
- {},
- {
- "description": "bytes read rate of the disk volume",
- "name": "diskBytesReadRate",
- "type": "long"
- },
- {
"description": "cluster name where the volume is allocated",
"name": "clustername",
"type": "string"
},
{
- "description": "the domain associated with the disk volume",
- "name": "domain",
+ "description": "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": "the account associated with the disk volume",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "min iops of the disk volume",
+ "name": "miniops",
+ "type": "long"
+ },
+ {
+ "description": "bytes read rate of the disk volume",
+ "name": "diskBytesReadRate",
+ "type": "long"
+ },
+ {
+ "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 availability zone",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "the path of the volume",
+ "name": "path",
+ "type": "string"
+ },
+ {
+ "description": "io requests write rate of the disk volume per the disk offering",
+ "name": "diskIopsWriteRate",
+ "type": "long"
+ },
+ {
+ "description": "name of the disk offering",
+ "name": "diskofferingname",
+ "type": "string"
+ },
+ {
+ "description": "the name of the ISO attached to the virtual machine",
+ "name": "isoname",
+ "type": "string"
+ },
+ {
+ "description": "the disk utilization",
+ "name": "utilization",
+ "type": "string"
+ },
+ {
+ "description": "name of the primary storage hosting the disk volume",
+ "name": "storage",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "an optional field whether to the display the volume to the end user or not.",
+ "name": "displayvolume",
+ "type": "boolean"
+ },
+ {
+ "description": "the name of the template for the virtual machine",
+ "name": "templatename",
+ "type": "string"
+ },
+ {
+ "description": "display name of the virtual machine",
+ "name": "vmdisplayname",
+ "type": "string"
+ },
+ {
+ "description": "size of the disk volume",
+ "name": "size",
+ "type": "long"
+ },
+ {},
+ {
+ "description": "name of the service offering for root disk",
+ "name": "serviceofferingname",
+ "type": "string"
+ },
+ {
+ "description": "the write (io) of disk on the vm",
+ "name": "diskiowrite",
+ "type": "long"
+ },
+ {
+ "description": "ID of the availability zone",
+ "name": "zoneid",
"type": "string"
}
]
@@ -9469,24 +9469,10 @@
"name": "listSecurityGroups",
"params": [
{
- "description": "",
+ "description": "list objects by project",
"length": 255,
- "name": "page",
- "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": "lists security groups by virtual machine id",
- "length": 255,
- "name": "virtualmachineid",
- "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,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",
+ "name": "projectid",
+ "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject",
"required": false,
"type": "uuid"
},
@@ -9498,11 +9484,34 @@
"type": "integer"
},
{
- "description": "List by keyword",
+ "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false",
"length": 255,
- "name": "keyword",
+ "name": "listall",
"required": false,
- "type": "string"
+ "type": "boolean"
+ },
+ {
+ "description": "list only resources belonging to the domain specified",
+ "length": 255,
+ "name": "domainid",
+ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
+ "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 the security group by the id provided",
+ "length": 255,
+ "name": "id",
+ "related": "createSecurityGroup,listSecurityGroups,updateSecurityGroup",
+ "required": false,
+ "type": "uuid"
},
{
"description": "lists security groups by name",
@@ -9519,298 +9528,61 @@
"type": "map"
},
{
- "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
+ "description": "list resources by account. Must be used with the domainId parameter.",
"length": 255,
- "name": "isrecursive",
+ "name": "account",
"required": false,
- "type": "boolean"
+ "type": "string"
},
{
- "description": "list only resources belonging to the domain specified",
+ "description": "List by keyword",
"length": 255,
- "name": "domainid",
- "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "lists security groups by virtual machine id",
+ "length": 255,
+ "name": "virtualmachineid",
+ "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,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",
"required": false,
"type": "uuid"
- },
- {
- "description": "list objects by project",
- "length": 255,
- "name": "projectid",
- "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "list the security group by the id provided",
- "length": 255,
- "name": "id",
- "related": "createSecurityGroup,listSecurityGroups,updateSecurityGroup",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false",
- "length": 255,
- "name": "listall",
- "required": false,
- "type": "boolean"
}
],
"related": "createSecurityGroup,updateSecurityGroup",
"response": [
{
- "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 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",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "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 project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the type of the ICMP message response",
- "name": "icmptype",
- "type": "integer"
- },
- {
- "description": "the CIDR notation for the base IP address of the security group rule",
- "name": "cidr",
- "type": "string"
- },
- {
- "description": "the code for the ICMP message response",
- "name": "icmpcode",
- "type": "integer"
- },
- {
- "description": "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 number of virtualmachines associated with this securitygroup",
- "name": "virtualmachinecount",
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
"type": "integer"
},
{
- "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 project id of the group",
- "name": "projectid",
- "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 type of the ICMP message response",
- "name": "icmptype",
- "type": "integer"
- },
- {
- "description": "the starting IP of the security group rule",
- "name": "startport",
- "type": "integer"
- },
- {
- "description": "the protocol of the security group rule",
- "name": "protocol",
- "type": "string"
- },
- {
- "description": "the ending IP of the security group rule ",
- "name": "endport",
- "type": "integer"
- },
- {
- "description": "account owning the security group rule",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the CIDR notation for the base IP address of the security group rule",
- "name": "cidr",
- "type": "string"
- },
- {
- "description": "the code for the ICMP message response",
- "name": "icmpcode",
- "type": "integer"
- },
- {
- "description": "the 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": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "the 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": "resource type",
- "name": "resourcetype",
- "type": "string"
- }
- ],
- "type": "set"
- }
- ],
- "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 ID of the security group",
- "name": "id",
+ "description": "the domain ID of the security group",
+ "name": "domainid",
"type": "string"
},
{
@@ -9819,17 +9591,43 @@
"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 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": "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"
},
{
@@ -9843,23 +9641,8 @@
"type": "string"
},
{
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
+ "description": "tag value",
+ "name": "value",
"type": "string"
},
{
@@ -9868,23 +9651,121 @@
"type": "string"
},
{
- "description": "resource type",
- "name": "resourcetype",
+ "description": "tag key name",
+ "name": "key",
"type": "string"
}
],
"type": "set"
},
- {},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the name of the security group",
- "name": "name",
- "type": "string"
+ "description": "the list of ingress rules associated with the security group",
+ "name": "ingressrule",
+ "response": [
+ {
+ "description": "the starting IP of the security group rule",
+ "name": "startport",
+ "type": "integer"
+ },
+ {
+ "description": "security group name",
+ "name": "securitygroupname",
+ "type": "string"
+ },
+ {
+ "description": "the ending IP of the security group rule ",
+ "name": "endport",
+ "type": "integer"
+ },
+ {
+ "description": "account owning the security group rule",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the list of resource tags associated with the rule",
+ "name": "tags",
+ "response": [
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "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 project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the id of the security group rule",
+ "name": "ruleid",
+ "type": "string"
+ },
+ {
+ "description": "the code for the ICMP message response",
+ "name": "icmpcode",
+ "type": "integer"
+ },
+ {
+ "description": "the type of the ICMP message response",
+ "name": "icmptype",
+ "type": "integer"
+ },
+ {
+ "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 virtualmachine ids associated with this securitygroup",
@@ -9892,9 +9773,128 @@
"type": "set"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
+ "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 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": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "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": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the id of the security group rule",
+ "name": "ruleid",
+ "type": "string"
+ },
+ {
+ "description": "security group name",
+ "name": "securitygroupname",
+ "type": "string"
+ },
+ {
+ "description": "the protocol of the security group rule",
+ "name": "protocol",
+ "type": "string"
+ },
+ {
+ "description": "account owning the security group rule",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the starting IP of the security group rule",
+ "name": "startport",
+ "type": "integer"
+ },
+ {
+ "description": "the CIDR notation for the base IP address of the security group rule",
+ "name": "cidr",
+ "type": "string"
+ },
+ {
+ "description": "the ending IP of the security group rule ",
+ "name": "endport",
+ "type": "integer"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the project id of the group",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the security group",
+ "name": "id",
+ "type": "string"
}
]
},
@@ -9904,6 +9904,21 @@
"name": "configureOutOfBandManagement",
"params": [
{
+ "description": "the host management interface IP address",
+ "length": 255,
+ "name": "address",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "the ID of the host",
+ "length": 255,
+ "name": "hostid",
+ "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost,listExternalLoadBalancers",
+ "required": true,
+ "type": "uuid"
+ },
+ {
"description": "the host management interface port",
"length": 255,
"name": "port",
@@ -9918,13 +9933,6 @@
"type": "string"
},
{
- "description": "the host management interface IP address",
- "length": 255,
- "name": "address",
- "required": true,
- "type": "string"
- },
- {
"description": "the host management interface password",
"length": 255,
"name": "password",
@@ -9932,14 +9940,6 @@
"type": "string"
},
{
- "description": "the ID of the host",
- "length": 255,
- "name": "hostid",
- "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost,listExternalLoadBalancers",
- "required": true,
- "type": "uuid"
- },
- {
"description": "the host management interface driver, for example: ipmitool",
"length": 255,
"name": "driver",
@@ -9950,68 +9950,68 @@
"related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,enableOutOfBandManagementForZone,disableOutOfBandManagementForZone,issueOutOfBandManagementPowerAction,changeOutOfBandManagementPassword",
"response": [
{
- "description": "true if out-of-band management is enabled for the host",
- "name": "enabled",
- "type": "boolean"
- },
- {
- "description": "the out-of-band management action (if issued)",
- "name": "action",
+ "description": "the out-of-band management interface address",
+ "name": "address",
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "the out-of-band management interface powerState of the host",
+ "name": "powerstate",
+ "type": "powerstate"
},
+ {},
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
{
- "description": "the out-of-band management driver for the host",
- "name": "driver",
- "type": "string"
- },
- {},
- {
- "description": "the out-of-band management interface powerState of the host",
- "name": "powerstate",
- "type": "powerstate"
- },
- {
- "description": "the operation result",
- "name": "status",
- "type": "boolean"
- },
- {},
- {
"description": "the operation result description",
"name": "description",
"type": "string"
},
{
- "description": "the ID of the host",
- "name": "hostid",
- "type": "string"
- },
- {
- "description": "the out-of-band management interface address",
- "name": "address",
- "type": "string"
- },
- {
"description": "the out-of-band management interface password",
"name": "password",
"type": "string"
},
{
+ "description": "the ID of the host",
+ "name": "hostid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the out-of-band management driver for the host",
+ "name": "driver",
+ "type": "string"
+ },
+ {
+ "description": "the operation result",
+ "name": "status",
+ "type": "boolean"
+ },
+ {
+ "description": "the 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": "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 interface port",
"name": "port",
"type": "string"
@@ -10025,11 +10025,11 @@
"name": "listStorageTags",
"params": [
{
- "description": "",
+ "description": "List by keyword",
"length": 255,
- "name": "page",
+ "name": "keyword",
"required": false,
- "type": "integer"
+ "type": "string"
},
{
"description": "",
@@ -10039,28 +10039,30 @@
"type": "integer"
},
{
- "description": "List by keyword",
+ "description": "",
"length": 255,
- "name": "keyword",
+ "name": "page",
"required": false,
- "type": "string"
+ "type": "integer"
}
],
"related": "",
"response": [
+ {},
+ {},
{
"description": "the pool ID of the storage tag",
"name": "poolid",
"type": "long"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the name of the storage tag",
+ "name": "name",
"type": "string"
},
{
- "description": "the ID of the storage tag",
- "name": "id",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
@@ -10069,12 +10071,10 @@
"type": "integer"
},
{
- "description": "the name of the storage tag",
- "name": "name",
+ "description": "the ID of the storage tag",
+ "name": "id",
"type": "string"
- },
- {},
- {}
+ }
]
},
{
@@ -10092,28 +10092,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": "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"
+ }
]
},
{
@@ -10133,13 +10133,13 @@
"related": "listIsoPermissions,listTemplatePermissions,listIsoPermissions",
"response": [
{
- "description": "the template ID",
- "name": "id",
- "type": "string"
+ "description": "true if this template is a public template, false otherwise",
+ "name": "ispublic",
+ "type": "boolean"
},
{
- "description": "the ID of the domain to which the template belongs",
- "name": "domainid",
+ "description": "the template ID",
+ "name": "id",
"type": "string"
},
{},
@@ -10148,6 +10148,16 @@
"name": "jobid",
"type": "string"
},
+ {
+ "description": "the list of accounts the template is available for",
+ "name": "account",
+ "type": "list"
+ },
+ {
+ "description": "the ID of the domain to which the template belongs",
+ "name": "domainid",
+ "type": "string"
+ },
{},
{
"description": "the list of projects the template is available for",
@@ -10158,16 +10168,6 @@
"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 list of accounts the template is available for",
- "name": "account",
- "type": "list"
}
]
},
@@ -10188,23 +10188,38 @@
"related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm",
"response": [
{
- "description": "the Pod ID for the system VM",
- "name": "podid",
+ "description": "the private IP address for the system VM",
+ "name": "privateip",
"type": "string"
},
{
- "description": "the public MAC address for the system VM",
- "name": "publicmacaddress",
+ "description": "the 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 date and time the system VM was created",
+ "name": "created",
+ "type": "date"
},
{
- "description": "the public netmask for the system VM",
- "name": "publicnetmask",
+ "description": "the Zone ID for the system VM",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the host ID for the system VM",
+ "name": "hostid",
+ "type": "string"
+ },
+ {
+ "description": "the agent state of the system VM",
+ "name": "agentstate",
+ "type": "string"
+ },
+ {
+ "description": "the link local netmask for the system vm",
+ "name": "linklocalnetmask",
"type": "string"
},
{
@@ -10213,73 +10228,95 @@
"type": "integer"
},
{
+ "description": "the gateway for the system VM",
+ "name": "gateway",
+ "type": "string"
+ },
+ {
+ "description": "public vlan range",
+ "name": "publicvlan",
+ "type": "list"
+ },
+ {
+ "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 first DNS for the system VM",
+ "name": "dns1",
+ "type": "string"
+ },
+ {
+ "description": "the hypervisor on which the template runs",
+ "name": "hypervisor",
+ "type": "string"
+ },
+ {
+ "description": "the number of active console sessions for the console proxy system vm",
+ "name": "activeviewersessions",
+ "type": "integer"
+ },
+ {
+ "description": "the 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 template ID for the system VM",
+ "name": "templateid",
+ "type": "string"
+ },
+ {
+ "description": "the public IP address for the system VM",
+ "name": "publicip",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the system VM",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "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 Zone name for the system VM",
"name": "zonename",
"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 date and time the system VM was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the public IP address for the system VM",
- "name": "publicip",
- "type": "string"
- },
- {
- "description": "the host ID for the system VM",
- "name": "hostid",
- "type": "string"
- },
- {
- "description": "the gateway for the system VM",
- "name": "gateway",
- "type": "string"
- },
- {
- "description": "the second DNS for the system VM",
- "name": "dns2",
- "type": "string"
- },
- {
- "description": "the last disconnected date of host",
- "name": "disconnected",
- "type": "date"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the Zone ID for the system VM",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the systemvm agent version",
- "name": "version",
- "type": "string"
- },
- {
- "description": "the ID of the system VM",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the system VM type",
- "name": "systemvmtype",
- "type": "string"
- },
- {
- "description": "the agent state of the system VM",
- "name": "agentstate",
+ "description": "the link local IP address for the system vm",
+ "name": "linklocalip",
"type": "string"
},
{
@@ -10288,19 +10325,43 @@
"type": "string"
},
{
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {},
- {
- "description": "the template ID for the system VM",
- "name": "templateid",
+ "description": "the state of the system VM",
+ "name": "state",
"type": "string"
},
{
- "description": "the hypervisor on which the template runs",
- "name": "hypervisor",
+ "description": "the private netmask for the system VM",
+ "name": "privatenetmask",
+ "type": "string"
+ },
+ {
+ "description": "the systemvm agent version",
+ "name": "version",
+ "type": "string"
+ },
+ {
+ "description": "the system VM type",
+ "name": "systemvmtype",
+ "type": "string"
+ },
+ {
+ "description": "guest vlan range",
+ "name": "guestvlan",
+ "type": "string"
+ },
+ {
+ "description": "the public netmask for the system VM",
+ "name": "publicnetmask",
+ "type": "string"
+ },
+ {
+ "description": "the template name for the system VM",
+ "name": "templatename",
+ "type": "string"
+ },
+ {
+ "description": "the public MAC address for the system VM",
+ "name": "publicmacaddress",
"type": "string"
},
{
@@ -10314,75 +10375,14 @@
"type": "string"
},
{
- "description": "public vlan range",
- "name": "publicvlan",
- "type": "list"
- },
- {
- "description": "the link local netmask for the system vm",
- "name": "linklocalnetmask",
- "type": "string"
- },
- {
- "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",
- "type": "string"
- },
- {
- "description": "the state of the system VM",
- "name": "state",
- "type": "string"
- },
- {
- "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.",
- "name": "isdynamicallyscalable",
- "type": "boolean"
- },
- {
- "description": "the number of active console sessions for the console proxy system vm",
- "name": "activeviewersessions",
- "type": "integer"
- },
- {
- "description": "the private netmask for the system VM",
- "name": "privatenetmask",
- "type": "string"
- },
- {
- "description": "the template name for the system VM",
- "name": "templatename",
+ "description": "the second DNS for the system VM",
+ "name": "dns2",
"type": "string"
},
{
"description": "the hostname for the system VM",
"name": "hostname",
"type": "string"
- },
- {
- "description": "the first DNS for the system VM",
- "name": "dns1",
- "type": "string"
- },
- {
- "description": "the link local IP address for the system vm",
- "name": "linklocalip",
- "type": "string"
- },
- {
- "description": "guest vlan range",
- "name": "guestvlan",
- "type": "string"
- },
- {
- "description": "the private IP address for the system VM",
- "name": "privateip",
- "type": "string"
}
]
},
@@ -10392,27 +10392,6 @@
"name": "listAnnotations",
"params": [
{
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
- },
- {
- "description": "",
- "length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
- },
- {
- "description": "the entity type",
- "length": 255,
- "name": "entitytype",
- "required": false,
- "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",
"length": 255,
"name": "annotationfilter",
@@ -10421,17 +10400,9 @@
"type": "string"
},
{
- "description": "optional: the id of the user of the annotation",
+ "description": "List by keyword",
"length": 255,
- "name": "userid",
- "required": false,
- "since": "4.16.0",
- "type": "string"
- },
- {
- "description": "the id of the entity for which to show annotations",
- "length": 255,
- "name": "entityid",
+ "name": "keyword",
"required": false,
"type": "string"
},
@@ -10445,26 +10416,55 @@
{
"description": "",
"length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "the id of the entity for which to show annotations",
+ "length": 255,
+ "name": "entityid",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the entity type",
+ "length": 255,
+ "name": "entitytype",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "",
+ "length": 255,
"name": "pagesize",
"required": false,
"type": "integer"
+ },
+ {
+ "description": "optional: the id of the user of the annotation",
+ "length": 255,
+ "name": "userid",
+ "required": false,
+ "since": "4.16.0",
+ "type": "string"
}
],
"related": "addAnnotation,removeAnnotation,updateAnnotationVisibility",
"response": [
{
- "description": "the contents of the annotation",
- "name": "annotation",
+ "description": "the (uu)id of the annotation",
+ "name": "id",
"type": "string"
},
{
- "description": "the removal timestamp for this annotation",
- "name": "removed",
- "type": "date"
+ "description": "the type of the annotated entity",
+ "name": "entitytype",
+ "type": "string"
},
{
- "description": "the name of the entitiy to which this annotation pertains",
- "name": "entityname",
+ "description": "The (uu)id of the user that entered the annotation",
+ "name": "userid",
"type": "string"
},
{
@@ -10473,28 +10473,13 @@
"type": "date"
},
{
- "description": "the (uu)id of the entitiy to which this annotation pertains",
- "name": "entityid",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
{
- "description": "the (uu)id of the annotation",
- "name": "id",
- "type": "string"
- },
- {
- "description": "The (uu)id of the user that entered the annotation",
- "name": "userid",
+ "description": "the contents of the annotation",
+ "name": "annotation",
"type": "string"
},
{},
@@ -10504,15 +10489,30 @@
"type": "boolean"
},
{
- "description": "The username of the user that entered the annotation",
- "name": "username",
+ "description": "the name of the entitiy to which this annotation pertains",
+ "name": "entityname",
+ "type": "string"
+ },
+ {
+ "description": "the (uu)id of the entitiy to which this annotation pertains",
+ "name": "entityid",
"type": "string"
},
{},
{
- "description": "the type of the annotated entity",
- "name": "entitytype",
+ "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 removal timestamp for this annotation",
+ "name": "removed",
+ "type": "date"
}
],
"since": "4.11"
@@ -10523,9 +10523,9 @@
"name": "addSwift",
"params": [
{
- "description": "the username for swift",
+ "description": "the account for swift",
"length": 255,
- "name": "username",
+ "name": "account",
"required": false,
"type": "string"
},
@@ -10537,57 +10537,35 @@
"type": "string"
},
{
- "description": "the account for swift",
+ "description": " key for the user for swift",
"length": 255,
- "name": "account",
+ "name": "key",
"required": false,
"type": "string"
},
{
- "description": " key for the user for swift",
+ "description": "the username for swift",
"length": 255,
- "name": "key",
+ "name": "username",
"required": false,
"type": "string"
}
],
"related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,listSecondaryStagingStores,updateCloudToUseObjectStore",
"response": [
- {},
{
"description": "the Zone name of the image store",
"name": "zonename",
"type": "string"
},
{
- "description": "the scope of the image store",
- "name": "scope",
- "type": "scopetype"
+ "description": "the host's currently used disk size",
+ "name": "disksizeused",
+ "type": "long"
},
{
- "description": "the name of the image store",
- "name": "name",
- "type": "string"
- },
- {
- "description": "defines if store is read-only",
- "name": "readonly",
- "type": "boolean"
- },
- {
- "description": "the protocol of the image store",
- "name": "protocol",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {},
- {
- "description": "the ID of the image store",
- "name": "id",
+ "description": "the Zone ID of the image store",
+ "name": "zoneid",
"type": "string"
},
{
@@ -10596,8 +10574,13 @@
"type": "long"
},
{
- "description": "the url of the image store",
- "name": "url",
+ "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"
},
{
@@ -10606,24 +10589,41 @@
"type": "string"
},
{
- "description": "the Zone ID of the image store",
- "name": "zoneid",
+ "description": "the url of the image store",
+ "name": "url",
"type": "string"
},
{
+ "description": "the name of the image store",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the image store",
+ "name": "id",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the scope of the image store",
+ "name": "scope",
+ "type": "scopetype"
+ },
+ {
"description": "true if the entity/resource has annotations",
"name": "hasannotations",
"type": "boolean"
},
{
- "description": "the host's currently used disk size",
- "name": "disksizeused",
- "type": "long"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
+ {},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
+ "description": "defines if store is read-only",
+ "name": "readonly",
+ "type": "boolean"
}
],
"since": "3.0.0"
@@ -10641,12 +10641,11 @@
"type": "date"
},
{
- "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\")",
@@ -10656,35 +10655,36 @@
"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"
}
],
"response": [
{
- "description": "true if operation is executed successfully",
- "name": "success",
- "type": "boolean"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
{},
- {},
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
{
"description": "any text associated with the success or failure",
"name": "displaytext",
"type": "string"
},
+ {},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "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"
}
]
},
@@ -10704,17 +10704,6 @@
],
"response": [
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {},
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
"description": "any text associated with the success or failure",
"name": "displaytext",
"type": "string"
@@ -10724,6 +10713,17 @@
"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"
@@ -10734,14 +10734,6 @@
"name": "addSrxFirewall",
"params": [
{
- "description": "the Physical Network ID",
- "length": 255,
- "name": "physicalnetworkid",
- "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork",
- "required": true,
- "type": "uuid"
- },
- {
"description": "supports only JuniperSRXFirewall",
"length": 255,
"name": "networkdevicetype",
@@ -10763,6 +10755,14 @@
"type": "string"
},
{
+ "description": "the Physical Network ID",
+ "length": 255,
+ "name": "physicalnetworkid",
+ "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork",
+ "required": true,
+ "type": "uuid"
+ },
+ {
"description": "Credentials to reach SRX firewall device",
"length": 255,
"name": "username",
@@ -10773,19 +10773,8 @@
"related": "configureSrxFirewall",
"response": [
{
- "description": "the private interface of the external firewall",
- "name": "privateinterface",
- "type": "string"
- },
- {},
- {
- "description": "the username that's used to log in to the external firewall",
- "name": "username",
- "type": "string"
- },
- {
- "description": "the public interface of the external firewall",
- "name": "publicinterface",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
@@ -10794,75 +10783,86 @@
"type": "string"
},
{
- "description": "the number of times to retry requests to the external firewall",
- "name": "numretries",
+ "description": "the username that's used to log in to the external firewall",
+ "name": "username",
"type": "string"
},
{
+ "description": "the zone ID of the external firewall",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "device state",
+ "name": "fwdevicestate",
+ "type": "string"
+ },
+ {
+ "description": "name of the provider",
+ "name": "provider",
+ "type": "string"
+ },
+ {},
+ {
"description": "the public security zone of the external firewall",
"name": "publiczone",
"type": "string"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the public interface of the external firewall",
+ "name": "publicinterface",
"type": "string"
},
{
- "description": "device name",
- "name": "fwdevicename",
+ "description": "the private interface of the external firewall",
+ "name": "privateinterface",
"type": "string"
},
+ {},
{
"description": "the private security zone of the external firewall",
"name": "privatezone",
"type": "string"
},
{
- "description": "name of the provider",
- "name": "provider",
- "type": "string"
- },
- {
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
{
+ "description": "the timeout (in seconds) for requests to the external firewall",
+ "name": "timeout",
+ "type": "string"
+ },
+ {
"description": "device capacity",
"name": "fwdevicecapacity",
"type": "long"
},
{
+ "description": "device name",
+ "name": "fwdevicename",
+ "type": "string"
+ },
+ {
+ "description": "the number of times to retry requests to the external firewall",
+ "name": "numretries",
+ "type": "string"
+ },
+ {
"description": "the physical network to which this SRX firewall belongs to",
"name": "physicalnetworkid",
"type": "string"
},
{
- "description": "the zone ID of the external firewall",
- "name": "zoneid",
- "type": "string"
- },
- {},
- {
- "description": "device state",
- "name": "fwdevicestate",
- "type": "string"
- },
- {
- "description": "the timeout (in seconds) for requests to the external firewall",
- "name": "timeout",
+ "description": "device id of the SRX firewall",
+ "name": "fwdeviceid",
"type": "string"
},
{
"description": "the usage interface of the external firewall",
"name": "usageinterface",
"type": "string"
- },
- {
- "description": "device id of the SRX firewall",
- "name": "fwdeviceid",
- "type": "string"
}
]
},
@@ -10880,20 +10880,20 @@
"type": "boolean"
},
{
- "description": "the ID of the load balancer",
- "length": 255,
- "name": "id",
- "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules",
- "required": true,
- "type": "uuid"
- },
- {
"description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only",
"length": 255,
"name": "customid",
"required": false,
"since": "4.4",
"type": "string"
+ },
+ {
+ "description": "the ID of the load balancer",
+ "length": 255,
+ "name": "id",
+ "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules",
+ "required": true,
+ "type": "uuid"
}
],
"related": "createLoadBalancer,listLoadBalancers",
@@ -10904,40 +10904,30 @@
"type": "string"
},
{
+ "description": "Load Balancer network id",
+ "name": "networkid",
+ "type": "string"
+ },
+ {
+ "description": "is rule for display to the regular user",
+ "name": "fordisplay",
+ "type": "boolean"
+ },
+ {
"description": "the list of resource tags associated with the Load Balancer",
"name": "tags",
"response": [
{
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
"description": "the account associated with the tag",
"name": "account",
"type": "string"
},
{
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
"description": "the ID of the domain associated with the tag",
"name": "domainid",
"type": "string"
@@ -10953,34 +10943,71 @@
"type": "string"
},
{
- "description": "resource type",
- "name": "resourcetype",
+ "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": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
"type": "string"
}
],
"type": "list"
},
{
- "description": "Load Balancer network id",
- "name": "networkid",
- "type": "string"
- },
- {
- "description": "the project id of the Load Balancer",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "is rule for display to the regular user",
- "name": "fordisplay",
- "type": "boolean"
- },
- {
"description": "the account of the Load Balancer",
"name": "account",
"type": "string"
},
{
+ "description": "the list of instances associated with the Load Balancer",
+ "name": "loadbalancerinstance",
+ "response": [
+ {
+ "description": "the ip address of the instance",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "the state of the instance",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "the instance ID",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the name of the instance",
+ "name": "name",
+ "type": "string"
+ }
+ ],
+ "type": "list"
+ },
+ {
+ "description": "Load Balancer source ip network id",
+ "name": "sourceipaddressnetworkid",
+ "type": "string"
+ },
+ {
"description": "the list of rules associated with the Load Balancer",
"name": "loadbalancerrule",
"response": [
@@ -11003,36 +11030,9 @@
"type": "list"
},
{
- "description": "the list of instances associated with the Load Balancer",
- "name": "loadbalancerinstance",
- "response": [
- {
- "description": "the state of the instance",
- "name": "state",
- "type": "string"
- },
- {
- "description": "the name of the instance",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the ip address of the instance",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "description": "the instance ID",
- "name": "id",
- "type": "string"
- }
- ],
- "type": "list"
- },
- {
- "description": "the description of the Load Balancer",
- "name": "description",
- "type": "string"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
{
"description": "the Load Balancer ID",
@@ -11040,13 +11040,25 @@
"type": "string"
},
{
- "description": "the domain of the Load Balancer",
- "name": "domain",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the description of the Load Balancer",
+ "name": "description",
"type": "string"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the domain ID of the Load Balancer",
+ "name": "domainid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the load balancer algorithm (source, roundrobin, leastconn)",
+ "name": "algorithm",
"type": "string"
},
{
@@ -11055,30 +11067,18 @@
"type": "string"
},
{
+ "description": "the domain of the Load Balancer",
+ "name": "domain",
+ "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 load balancer algorithm (source, roundrobin, leastconn)",
- "name": "algorithm",
- "type": "string"
- },
- {
- "description": "Load Balancer source ip network id",
- "name": "sourceipaddressnetworkid",
- "type": "string"
- },
- {
- "description": "the domain ID of the Load Balancer",
- "name": "domainid",
+ "description": "the project id of the Load Balancer",
+ "name": "projectid",
"type": "string"
}
],
@@ -11090,6 +11090,14 @@
"name": "scaleSystemVm",
"params": [
{
+ "description": "The ID of the system vm",
+ "length": 255,
+ "name": "id",
+ "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm",
+ "required": true,
+ "type": "uuid"
+ },
+ {
"description": "name value pairs of custom parameters for cpu, memory and cpunumber. example details[i].name=value",
"length": 255,
"name": "details",
@@ -11103,101 +11111,53 @@
"related": "createServiceOffering,updateServiceOffering,listServiceOfferings",
"required": true,
"type": "uuid"
- },
- {
- "description": "The ID of the system vm",
- "length": 255,
- "name": "id",
- "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm",
- "required": true,
- "type": "uuid"
}
],
"related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm",
"response": [
{
+ "description": "the Pod ID for the system VM",
+ "name": "podid",
+ "type": "string"
+ },
+ {
+ "description": "the system VM type",
+ "name": "systemvmtype",
+ "type": "string"
+ },
+ {
+ "description": "the gateway for the system VM",
+ "name": "gateway",
+ "type": "string"
+ },
+ {
+ "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.",
+ "name": "isdynamicallyscalable",
+ "type": "boolean"
+ },
+ {
"description": "the private IP address for the system VM",
"name": "privateip",
"type": "string"
},
{
- "description": "the link local netmask for the system vm",
- "name": "linklocalnetmask",
- "type": "string"
- },
- {
- "description": "the template name for the system VM",
- "name": "templatename",
- "type": "string"
- },
- {
- "description": "the public MAC address for the system VM",
- "name": "publicmacaddress",
- "type": "string"
- },
- {
- "description": "the public netmask for the system VM",
- "name": "publicnetmask",
- "type": "string"
- },
- {
- "description": "guest vlan range",
- "name": "guestvlan",
- "type": "string"
- },
- {
- "description": "the ID of the system VM",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the last disconnected date of host",
- "name": "disconnected",
- "type": "date"
- },
- {
- "description": "the agent state of the system VM",
- "name": "agentstate",
- "type": "string"
- },
- {
- "description": "the number of active console sessions for the console proxy system vm",
- "name": "activeviewersessions",
- "type": "integer"
- },
- {
"description": "true if the entity/resource has annotations",
"name": "hasannotations",
"type": "boolean"
},
{
- "description": "the 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 host ID for the system VM",
- "name": "hostid",
- "type": "string"
- },
- {
- "description": "the link local IP address for the system vm",
- "name": "linklocalip",
- "type": "string"
- },
- {
- "description": "the second DNS for the system VM",
- "name": "dns2",
- "type": "string"
- },
- {
- "description": "the date and time the system VM was created",
- "name": "created",
+ "description": "the last disconnected date of host",
+ "name": "disconnected",
"type": "date"
},
{
- "description": "the state of the system VM",
- "name": "state",
+ "description": "the number of active console sessions for the console proxy system vm",
+ "name": "activeviewersessions",
+ "type": "integer"
+ },
+ {
+ "description": "the ID of the system VM",
+ "name": "id",
"type": "string"
},
{
@@ -11206,21 +11166,16 @@
"type": "string"
},
{
- "description": "the systemvm agent version",
- "name": "version",
- "type": "string"
- },
- {
- "description": "the Zone name for the system VM",
- "name": "zonename",
- "type": "string"
- },
- {
"description": "the public IP address for the system VM",
"name": "publicip",
"type": "string"
},
{
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
"description": "the hostname for the system VM",
"name": "hostname",
"type": "string"
@@ -11231,75 +11186,33 @@
"type": "string"
},
{
- "description": "the Zone ID for the system VM",
- "name": "zoneid",
+ "description": "the template ID for the system VM",
+ "name": "templateid",
"type": "string"
},
- {},
- {},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the Zone name for the system VM",
+ "name": "zonename",
"type": "string"
},
{
+ "description": "the date and time the system VM was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
"description": "the hypervisor on which the template runs",
"name": "hypervisor",
"type": "string"
},
{
- "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.",
- "name": "jobid",
+ "description": "the template name for the system VM",
+ "name": "templatename",
"type": "string"
},
{
- "description": "the name of the system VM",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the Pod name for the system VM",
- "name": "podname",
- "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",
- "type": "string"
- },
- {
- "description": "the network domain for the system VM",
- "name": "networkdomain",
- "type": "string"
- },
- {
- "description": "the template ID for the system VM",
- "name": "templateid",
- "type": "string"
- },
- {
- "description": "the private netmask for the system VM",
- "name": "privatenetmask",
- "type": "string"
- },
- {
- "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.",
- "name": "isdynamicallyscalable",
- "type": "boolean"
- },
- {
- "description": "public vlan range",
- "name": "publicvlan",
- "type": "list"
- },
- {
- "description": "the Pod ID for the system VM",
- "name": "podid",
+ "description": "the Zone ID for the system VM",
+ "name": "zoneid",
"type": "string"
},
{
@@ -11308,8 +11221,95 @@
"type": "string"
},
{
- "description": "the gateway for the system VM",
- "name": "gateway",
+ "description": "public vlan range",
+ "name": "publicvlan",
+ "type": "list"
+ },
+ {
+ "description": "the systemvm agent version",
+ "name": "version",
+ "type": "string"
+ },
+ {
+ "description": "the agent state of the system VM",
+ "name": "agentstate",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "guest vlan range",
+ "name": "guestvlan",
+ "type": "string"
+ },
+ {
+ "description": "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 system VM",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the second DNS for the system VM",
+ "name": "dns2",
+ "type": "string"
+ },
+ {
+ "description": "the Pod name for the system VM",
+ "name": "podname",
+ "type": "string"
+ },
+ {
+ "description": "the link local IP address for the system vm",
+ "name": "linklocalip",
+ "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 public MAC address for the system VM",
+ "name": "publicmacaddress",
+ "type": "string"
+ },
+ {
+ "description": "the state of the system VM",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "the link local netmask for the system vm",
+ "name": "linklocalnetmask",
+ "type": "string"
+ },
+ {
+ "description": "the network domain for the system VM",
+ "name": "networkdomain",
+ "type": "string"
+ },
+ {
+ "description": "the public netmask for the system VM",
+ "name": "publicnetmask",
+ "type": "string"
+ },
+ {
+ "description": "the host ID for the system VM",
+ "name": "hostid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the private netmask for the system VM",
+ "name": "privatenetmask",
"type": "string"
}
]
@@ -11320,6 +11320,14 @@
"name": "listSnapshotPolicies",
"params": [
{
+ "description": "the ID of the snapshot policy",
+ "length": 255,
+ "name": "id",
+ "related": "createSnapshotPolicy,updateSnapshotPolicy,listSnapshotPolicies",
+ "required": false,
+ "type": "uuid"
+ },
+ {
"description": "",
"length": 255,
"name": "page",
@@ -11335,11 +11343,11 @@
"type": "uuid"
},
{
- "description": "List by keyword",
+ "description": "",
"length": 255,
- "name": "keyword",
+ "name": "pagesize",
"required": false,
- "type": "string"
+ "type": "integer"
},
{
"description": "list resources by display flag; only ROOT admin is eligible to pass this parameter",
@@ -11350,61 +11358,69 @@
"type": "boolean"
},
{
- "description": "",
+ "description": "List by keyword",
"length": 255,
- "name": "pagesize",
+ "name": "keyword",
"required": false,
- "type": "integer"
- },
- {
- "description": "the ID of the snapshot policy",
- "length": 255,
- "name": "id",
- "related": "createSnapshotPolicy,updateSnapshotPolicy,listSnapshotPolicies",
- "required": false,
- "type": "uuid"
+ "type": "string"
}
],
"related": "createSnapshotPolicy,updateSnapshotPolicy",
"response": [
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the interval type of the snapshot policy",
- "name": "intervaltype",
- "type": "short"
- },
- {
"description": "true if the entity/resource has annotations",
"name": "hasannotations",
"type": "boolean"
},
{
+ "description": "maximum number of snapshots retained",
+ "name": "maxsnaps",
+ "type": "int"
+ },
+ {
"description": "the ID of the snapshot policy",
"name": "id",
"type": "string"
},
+ {},
{
"description": "is this policy for display to the regular user",
"name": "fordisplay",
"type": "boolean"
},
+ {
+ "description": "time the snapshot is scheduled to be taken.",
+ "name": "schedule",
+ "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": "the current status of the latest async job acting 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 list of resource tags associated",
"name": "tags",
"response": [
{
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
"type": "string"
},
{
@@ -11413,13 +11429,13 @@
"type": "string"
},
{
- "description": "the project name where tag belongs to",
- "name": "project",
+ "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"
},
{
@@ -11428,50 +11444,34 @@
"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",
+ "description": "tag value",
+ "name": "value",
"type": "string"
},
{
"description": "the ID of the domain associated with the tag",
"name": "domainid",
"type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
}
],
"type": "set"
},
{
- "description": "maximum number of snapshots retained",
- "name": "maxsnaps",
- "type": "int"
- },
- {
- "description": "the time zone of the snapshot policy",
- "name": "timezone",
- "type": "string"
- },
- {
- "description": "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 ID of the disk volume",
"name": "volumeid",
"type": "string"
@@ -11484,34 +11484,20 @@
"name": "updateVpnCustomerGateway",
"params": [
{
- "description": "guest cidr of the customer gateway. Multiple entries must be separated by a single comma character (,).",
+ "description": "the account associated with the gateway. Must be used with the domainId parameter.",
"length": 255,
- "name": "cidrlist",
- "required": true,
+ "name": "account",
+ "required": false,
"type": "string"
},
{
- "description": "public ip address id of the customer gateway",
+ "description": "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.",
"length": 255,
- "name": "gateway",
+ "name": "ipsecpsk",
"required": true,
"type": "string"
},
{
- "description": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds",
- "length": 255,
- "name": "esplifetime",
- "required": false,
- "type": "long"
- },
- {
- "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds",
- "length": 255,
- "name": "ikelifetime",
- "required": false,
- "type": "long"
- },
- {
"description": "If DPD is enabled for VPN connection",
"length": 255,
"name": "dpd",
@@ -11519,12 +11505,33 @@
"type": "boolean"
},
{
- "description": "id of customer gateway",
+ "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.",
"length": 255,
- "name": "id",
- "related": "createVpnCustomerGateway,listVpnCustomerGateways,updateVpnCustomerGateway",
+ "name": "splitconnections",
+ "required": false,
+ "since": "4.15.1",
+ "type": "boolean"
+ },
+ {
+ "description": "IKE policy of the customer gateway",
+ "length": 255,
+ "name": "ikepolicy",
"required": true,
- "type": "uuid"
+ "type": "string"
+ },
+ {
+ "description": "guest cidr of the customer gateway. Multiple entries must be separated by a single comma character (,).",
+ "length": 255,
+ "name": "cidrlist",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds",
+ "length": 255,
+ "name": "ikelifetime",
+ "required": false,
+ "type": "long"
},
{
"description": "ESP policy of the customer gateway",
@@ -11534,9 +11541,9 @@
"type": "string"
},
{
- "description": "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.",
+ "description": "public ip address id of the customer gateway",
"length": 255,
- "name": "ipsecpsk",
+ "name": "gateway",
"required": true,
"type": "string"
},
@@ -11548,17 +11555,32 @@
"type": "boolean"
},
{
- "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.",
+ "description": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds",
"length": 255,
- "name": "splitconnections",
+ "name": "esplifetime",
"required": false,
- "since": "4.15.1",
- "type": "boolean"
+ "type": "long"
},
{
- "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,listDomainChildren,listDomains,listDomains,updateDomain",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "id of customer gateway",
+ "length": 255,
+ "name": "id",
+ "related": "createVpnCustomerGateway,listVpnCustomerGateways,updateVpnCustomerGateway",
+ "required": true,
+ "type": "uuid"
+ },
+ {
+ "description": "name of this customer gateway",
+ "length": 255,
+ "name": "name",
"required": false,
"type": "string"
},
@@ -11569,52 +11591,14 @@
"required": false,
"since": "4.15.1",
"type": "string"
- },
- {
- "description": "IKE policy of the customer gateway",
- "length": 255,
- "name": "ikepolicy",
- "required": true,
- "type": "string"
- },
- {
- "description": "name of this customer gateway",
- "length": 255,
- "name": "name",
- "required": false,
- "type": "string"
- },
- {
- "description": "the domain ID associated with the gateway. If used with the account parameter returns the gateway associated with the account for the specified domain.",
- "length": 255,
- "name": "domainid",
- "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
- "required": false,
- "type": "uuid"
}
],
"related": "createVpnCustomerGateway,listVpnCustomerGateways",
"response": [
{
- "description": "guest ip of the customer gateway",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "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",
- "type": "string"
+ "description": "the date and time the host was removed",
+ "name": "removed",
+ "type": "date"
},
{
"description": "the vpn gateway ID",
@@ -11622,79 +11606,18 @@
"type": "string"
},
{
- "description": "IPsec preshared-key of customer gateway",
- "name": "ipsecpsk",
- "type": "string"
- },
- {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"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 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": "the owner",
- "name": "account",
- "type": "string"
- },
- {
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "the project id",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "if Force NAT Encapsulation is enabled for customer gateway",
- "name": "forceencap",
- "type": "boolean"
- },
- {},
- {
- "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike",
- "name": "ikeversion",
- "type": "string"
- },
- {
- "description": "the domain name of the owner",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "public ip address id of the customer gateway",
- "name": "gateway",
- "type": "string"
- },
- {
- "description": "Lifetime of IKE SA of customer gateway",
- "name": "ikelifetime",
- "type": "long"
- },
- {
- "description": "the date and time the host was removed",
- "name": "removed",
- "type": "date"
- },
- {
- "description": "name of the customer gateway",
- "name": "name",
+ "description": "guest ip of the customer gateway",
+ "name": "ipaddress",
"type": "string"
},
{
@@ -11703,14 +11626,91 @@
"type": "boolean"
},
{
- "description": "IKE policy of customer gateway",
- "name": "ikepolicy",
+ "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike",
+ "name": "ikeversion",
"type": "string"
},
{
+ "description": "name of the customer gateway",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "Lifetime of IKE SA of customer gateway",
+ "name": "ikelifetime",
+ "type": "long"
+ },
+ {
"description": "if DPD is enabled for customer gateway",
"name": "dpd",
"type": "boolean"
+ },
+ {
+ "description": "the 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": "Lifetime of ESP SA of customer gateway",
+ "name": "esplifetime",
+ "type": "long"
+ },
+ {},
+ {
+ "description": "IKE policy of customer gateway",
+ "name": "ikepolicy",
+ "type": "string"
+ },
+ {
+ "description": "the owner",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the domain id of the owner",
+ "name": "domainid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "IPsec policy of customer gateway",
+ "name": "esppolicy",
+ "type": "string"
+ },
+ {
+ "description": "the project id",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the project name",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "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"
}
]
},
@@ -11720,177 +11720,41 @@
"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,
"name": "domainid",
"related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
"required": true,
"type": "uuid"
+ },
+ {
+ "description": "Locks the specified account.",
+ "length": 255,
+ "name": "account",
+ "required": true,
+ "type": "string"
}
],
"related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts",
"response": [
{
- "description": "the total volume which can be used by this account",
- "name": "volumelimit",
- "type": "string"
- },
- {
- "description": "the total number of network traffic bytes sent",
- "name": "sentbytes",
- "type": "long"
- },
- {
- "description": "the total number of virtual machines available for this account to acquire",
- "name": "vmavailable",
- "type": "string"
- },
- {
- "description": "the name of the role",
- "name": "rolename",
- "type": "string"
- },
- {
- "description": "the total number of networks owned by account",
- "name": "networktotal",
- "type": "long"
- },
- {
- "description": "path of the Domain the account belongs to",
- "name": "domainpath",
- "type": "string"
- },
- {
- "description": "the total number of templates which have been created by this account",
- "name": "templatetotal",
- "type": "long"
- },
- {
- "description": "true if account is default, false otherwise",
- "name": "isdefault",
+ "description": "true if the account requires cleanup",
+ "name": "iscleanuprequired",
"type": "boolean"
},
{
- "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",
- "type": "string"
- },
- {
- "description": "the total volume being used by this account",
- "name": "volumetotal",
+ "description": "the total number of cpu cores owned by account",
+ "name": "cputotal",
"type": "long"
},
{
- "description": "the total secondary storage space (in GiB) available to be used for this account",
- "name": "secondarystorageavailable",
- "type": "string"
- },
- {
- "description": "the total number of 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 total memory (in MB) owned by account",
- "name": "memorytotal",
- "type": "long"
- },
- {
- "description": "the total number of public ip addresses allocated for this account",
- "name": "iptotal",
- "type": "long"
- },
- {
- "description": "the state of the account",
- "name": "state",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
"description": "the total number of templates available to be created by this account",
"name": "templateavailable",
"type": "string"
},
{
- "description": "the total number of cpu cores the account can own",
- "name": "cpulimit",
- "type": "string"
- },
- {
- "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": "the total number of virtual machines deployed by this account",
- "name": "vmtotal",
- "type": "long"
- },
- {
- "description": "the total number of networks the account can own",
- "name": "networklimit",
- "type": "string"
- },
- {
- "description": "the total number of virtual machines stopped for this account",
- "name": "vmstopped",
- "type": "integer"
- },
- {
- "description": "details for the account",
- "name": "accountdetails",
- "type": "map"
- },
- {},
- {
- "description": "the total number of virtual machines running for this account",
- "name": "vmrunning",
- "type": "integer"
- },
- {
- "description": "account type (admin, domain-admin, user)",
- "name": "accounttype",
- "type": "short"
- },
- {
- "description": "the total number of vpcs available to be created for this account",
- "name": "vpcavailable",
- "type": "string"
- },
- {
- "description": "the total number of public ip addresses this account can acquire",
- "name": "iplimit",
- "type": "string"
- },
- {
- "description": "the total number of public ip addresses available for this account to acquire",
- "name": "ipavailable",
+ "description": "the state of the account",
+ "name": "state",
"type": "string"
},
{
@@ -11899,213 +11763,97 @@
"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 number of vpcs owned by account",
- "name": "vpctotal",
- "type": "long"
- },
- {
- "description": "the total number of templates which can be created by this account",
- "name": "templatelimit",
+ "description": "the total volume which can be used by this account",
+ "name": "volumelimit",
"type": "string"
},
{
- "description": "the date when this account was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the total secondary storage space (in GiB) the account can own",
- "name": "secondarystoragelimit",
+ "description": "the name of the account",
+ "name": "name",
"type": "string"
},
{
- "description": "the list of acl groups that account belongs to",
- "name": "groups",
- "type": "list"
- },
- {
"description": "Base64 string representation of the resource icon",
"name": "icon",
"type": "resourceiconresponse"
},
{
+ "description": "the total number of projects available for administration by this account",
+ "name": "projectavailable",
+ "type": "string"
+ },
+ {
+ "description": "path of the Domain the account belongs to",
+ "name": "domainpath",
+ "type": "string"
+ },
+ {
+ "description": "the total number of networks owned by account",
+ "name": "networktotal",
+ "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 received",
+ "name": "receivedbytes",
+ "type": "long"
+ },
+ {
+ "description": "the date when this account was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the total number of vpcs available to be created for this account",
+ "name": "vpcavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of virtual machines available for this account to acquire",
+ "name": "vmavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of snapshots stored by this account",
+ "name": "snapshottotal",
+ "type": "long"
+ },
+ {
"description": "the total memory (in MB) the account can own",
"name": "memorylimit",
"type": "string"
},
{
+ "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 primary storage space (in GiB) the account can own",
- "name": "primarystoragelimit",
- "type": "string"
- },
- {
- "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) 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 snapshots which can be stored by this account",
- "name": "snapshotlimit",
- "type": "string"
- },
- {},
- {
- "description": "the total secondary storage space (in GiB) owned by account",
- "name": "secondarystoragetotal",
- "type": "float"
- },
- {
- "description": "name of the Domain the account belongs to",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the total number of networks available to be created for this account",
- "name": "networkavailable",
- "type": "string"
- },
- {
- "description": "the default zone of the account",
- "name": "defaultzoneid",
- "type": "string"
- },
- {
- "description": "the total number of cpu cores owned by account",
- "name": "cputotal",
- "type": "long"
- },
- {
- "description": "true if the account requires cleanup",
- "name": "iscleanuprequired",
+ "description": "true if account is default, false otherwise",
+ "name": "isdefault",
"type": "boolean"
},
{
- "description": "the total volume available for this account",
- "name": "volumeavailable",
- "type": "string"
- },
- {
- "description": "id of the Domain the account belongs to",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the network domain",
- "name": "networkdomain",
- "type": "string"
- },
- {
- "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",
- "type": "string"
- },
- {
- "description": "the total primary storage space (in GiB) owned by account",
- "name": "primarystoragetotal",
- "type": "long"
- },
- {
- "description": "the name of the account",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the id of the account",
- "name": "id",
- "type": "string"
- },
- {
"description": "the list of users associated with account",
"name": "user",
"response": [
{
- "description": "the secret key of the user",
- "name": "secretkey",
- "type": "string"
- },
- {
- "description": "the user state",
- "name": "state",
- "type": "string"
- },
- {
- "description": "the date and time the user account was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the timezone user was created in",
- "name": "timezone",
- "type": "string"
- },
- {
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
- },
- {
- "description": "the api key of the user",
- "name": "apikey",
- "type": "string"
- },
- {
- "description": "the domain name of the user",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the account ID of the user",
- "name": "accountid",
- "type": "string"
- },
- {
- "description": "the boolean value representing if the updating target is in caller's child domain",
- "name": "iscallerchilddomain",
- "type": "boolean"
- },
- {
- "description": "the user email address",
- "name": "email",
- "type": "string"
- },
- {
- "description": "the user ID",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the ID of the role",
- "name": "roleid",
- "type": "string"
- },
- {
- "description": "the name of the role",
- "name": "rolename",
+ "description": "the user name",
+ "name": "username",
"type": "string"
},
{
@@ -12114,13 +11862,23 @@
"type": "string"
},
{
- "description": "true if user is default, false otherwise",
- "name": "isdefault",
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "description": "the user ID",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the boolean value representing if the updating target is in caller's child domain",
+ "name": "iscallerchilddomain",
"type": "boolean"
},
{
- "description": "the account name of the user",
- "name": "account",
+ "description": "the user state",
+ "name": "state",
"type": "string"
},
{
@@ -12129,8 +11887,23 @@
"type": "string"
},
{
- "description": "the user name",
- "name": "username",
+ "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 ID of the role",
+ "name": "roleid",
+ "type": "string"
+ },
+ {
+ "description": "the domain name of the user",
+ "name": "domain",
"type": "string"
},
{
@@ -12139,11 +11912,6 @@
"type": "short"
},
{
- "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"
@@ -12152,9 +11920,241 @@
"description": "the user firstname",
"name": "firstname",
"type": "string"
+ },
+ {
+ "description": "the name of the role",
+ "name": "rolename",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID of the user",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the timezone user was created in",
+ "name": "timezone",
+ "type": "string"
+ },
+ {
+ "description": "the user email address",
+ "name": "email",
+ "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 secret key of the user",
+ "name": "secretkey",
+ "type": "string"
+ },
+ {
+ "description": "true if user is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
}
],
"type": "list"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the list of acl groups that account belongs to",
+ "name": "groups",
+ "type": "list"
+ },
+ {
+ "description": "the default zone of the account",
+ "name": "defaultzoneid",
+ "type": "string"
+ },
+ {
+ "description": "name of the Domain the account belongs to",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the total number of snapshots available for this account",
+ "name": "snapshotavailable",
+ "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 public ip addresses allocated for this account",
+ "name": "iptotal",
+ "type": "long"
+ },
+ {
+ "description": "the name of the role",
+ "name": "rolename",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the 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) owned by account",
+ "name": "primarystoragetotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of templates which have been created by this account",
+ "name": "templatetotal",
+ "type": "long"
+ },
+ {
+ "description": "the id of the account",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "id of the Domain the account belongs to",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "details for the account",
+ "name": "accountdetails",
+ "type": "map"
+ },
+ {
+ "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 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",
+ "type": "long"
+ },
+ {
+ "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) owned by account",
+ "name": "secondarystoragetotal",
+ "type": "float"
+ },
+ {
+ "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",
+ "type": "long"
+ },
+ {
+ "description": "the total number of projects being administrated by this account",
+ "name": "projecttotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of snapshots which can be stored by this account",
+ "name": "snapshotlimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of templates which can be created by this account",
+ "name": "templatelimit",
+ "type": "string"
+ },
+ {
+ "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)",
+ "name": "roletype",
+ "type": "string"
+ },
+ {
+ "description": "account type (admin, domain-admin, user)",
+ "name": "accounttype",
+ "type": "short"
+ },
+ {
+ "description": "the total number of virtual machines that can be deployed by this account",
+ "name": "vmlimit",
+ "type": "string"
+ },
+ {
+ "description": "the total secondary storage space (in GiB) the account can own",
+ "name": "secondarystoragelimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of network traffic bytes sent",
+ "name": "sentbytes",
+ "type": "long"
+ },
+ {
+ "description": "the total number of networks available to be created for this account",
+ "name": "networkavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total volume available for this account",
+ "name": "volumeavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of public ip addresses this account can acquire",
+ "name": "iplimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of virtual machines stopped for this account",
+ "name": "vmstopped",
+ "type": "integer"
+ },
+ {
+ "description": "the network domain",
+ "name": "networkdomain",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the total number of projects the account can own",
+ "name": "projectlimit",
+ "type": "string"
+ },
+ {
+ "description": "the total memory (in MB) owned by account",
+ "name": "memorytotal",
+ "type": "long"
}
]
},
@@ -12182,163 +12182,28 @@
"related": "destroyRouter,listRouters,rebootRouter,startRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx",
"response": [
{
- "description": "the second IPv6 DNS for the router",
- "name": "ip6dns2",
- "type": "string"
- },
- {
- "description": "the project id of the ipaddress",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the name of the service offering of the virtual machine",
- "name": "serviceofferingname",
- "type": "string"
- },
- {
- "description": "the ID of the corresponding public network",
- "name": "publicnetworkid",
- "type": "string"
- },
- {
- "description": "the name of the router",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the hypervisor on which the template runs",
- "name": "hypervisor",
- "type": "string"
- },
- {
- "description": "VPC the router belongs to",
- "name": "vpcid",
- "type": "string"
- },
- {
- "description": "the public IP address for the router",
- "name": "publicip",
- "type": "string"
- },
- {
- "description": "the link local netmask for the router",
- "name": "linklocalnetmask",
- "type": "string"
- },
- {
- "description": "the network domain for the router",
- "name": "networkdomain",
- "type": "string"
- },
- {
- "description": "the state of the router",
- "name": "state",
- "type": "state"
- },
- {
"description": "the account associated with the router",
"name": "account",
"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 first DNS for the router",
- "name": "dns1",
- "type": "string"
- },
- {
"description": "the host ID for the router",
"name": "hostid",
"type": "string"
},
{
- "description": "the Zone ID for the router",
- "name": "zoneid",
+ "description": "the public netmask for the router",
+ "name": "publicnetmask",
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "the state of the router",
+ "name": "state",
+ "type": "state"
},
{
- "description": "the Zone name for the router",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "the version of scripts",
- "name": "scriptsversion",
- "type": "string"
- },
- {
- "description": "the second DNS for the router",
- "name": "dns2",
- "type": "string"
- },
- {
- "description": "the first IPv6 DNS for the router",
- "name": "ip6dns1",
- "type": "string"
- },
- {
- "description": "the template name for the router",
- "name": "templatename",
- "type": "string"
- },
- {
- "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",
- "type": "string"
- },
- {
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "the project name of the address",
- "name": "project",
- "type": "string"
- },
- {
- "description": "if this router is an redundant virtual router",
- "name": "isredundantrouter",
- "type": "boolean"
- },
- {
- "description": "the date and time the router was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the name of the corresponding guest network",
- "name": "guestnetworkname",
- "type": "string"
- },
- {
- "description": "the domain ID associated with the router",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the version of template",
- "name": "version",
+ "description": "the name of the router",
+ "name": "name",
"type": "string"
},
{
@@ -12346,82 +12211,19 @@
"name": "redundantstate",
"type": "string"
},
- {},
- {
- "description": "the guest IP address for the router",
- "name": "guestipaddress",
- "type": "string"
- },
{
"description": "the link local IP address for the router",
"name": "linklocalip",
"type": "string"
},
{
- "description": "the name of VPC the router belongs to",
- "name": "vpcname",
- "type": "string"
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
},
{
- "description": "the link local MAC address for the router",
- "name": "linklocalmacaddress",
- "type": "string"
- },
- {
- "description": "the id of the router",
- "name": "id",
- "type": "string"
- },
- {
- "description": "role of the domain router",
- "name": "role",
- "type": "string"
- },
- {
- "description": "the guest MAC address for the router",
- "name": "guestmacaddress",
- "type": "string"
- },
- {
- "description": "the ID of the service offering of the virtual machine",
- "name": "serviceofferingid",
- "type": "string"
- },
- {
- "description": "Last executed health check result for the router",
- "name": "healthcheckresults",
- "response": [
- {
- "description": "the 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": "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 hostname for the router",
- "name": "hostname",
+ "description": "the domain associated with the router",
+ "name": "domain",
"type": "string"
},
{
@@ -12429,38 +12231,13 @@
"name": "nic",
"response": [
{
- "description": "the type of the nic",
- "name": "type",
+ "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 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 Secondary ipv4 addr of nic",
- "name": "secondaryip",
- "type": "list"
- },
- {
- "description": "the traffic type of the nic",
- "name": "traffictype",
- "type": "string"
- },
- {
- "description": "Id of the vm to which the nic belongs",
- "name": "virtualmachineid",
+ "description": "the ip address of the nic",
+ "name": "ipaddress",
"type": "string"
},
{
@@ -12469,69 +12246,14 @@
"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 cidr of IPv6 network",
- "name": "ip6cidr",
- "type": "string"
- },
- {
- "description": "the netmask of the nic",
- "name": "netmask",
- "type": "string"
- },
- {
- "description": "the isolation uri of the nic",
- "name": "isolationuri",
- "type": "string"
- },
- {
"description": "the name of the corresponding network",
"name": "networkname",
"type": "string"
},
{
- "description": "true if nic is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
- },
- {
- "description": "the isolated private VLAN if available",
- "name": "isolatedpvlan",
- "type": "integer"
- },
- {
- "description": "the ID of the nic",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the ID of the corresponding network",
- "name": "networkid",
- "type": "string"
- },
- {
- "description": "the broadcast uri of the nic",
- "name": "broadcasturi",
- "type": "string"
- },
- {
- "description": "the gateway of IPv6 network",
- "name": "ip6gateway",
- "type": "string"
- },
- {
- "description": "Type of adapter if available",
- "name": "adaptertype",
- "type": "string"
+ "description": "the extra dhcp options on the nic",
+ "name": "extradhcpoption",
+ "type": "list"
},
{
"description": "the IPv6 address of network",
@@ -12544,32 +12266,156 @@
"type": "string"
},
{
- "description": "the ip address of the nic",
- "name": "ipaddress",
+ "description": "ID of the VLAN/VNI if available",
+ "name": "vlanid",
+ "type": "integer"
+ },
+ {
+ "description": "the ID of the nic",
+ "name": "id",
"type": "string"
},
{
+ "description": "Id of the NSX Logical Switch (if NSX based), null otherwise",
+ "name": "nsxlogicalswitch",
+ "type": "string"
+ },
+ {
+ "description": "the gateway of the nic",
+ "name": "gateway",
+ "type": "string"
+ },
+ {
+ "description": "the isolation uri of the nic",
+ "name": "isolationuri",
+ "type": "string"
+ },
+ {
+ "description": "true if nic is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {
"description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise",
"name": "nsxlogicalswitchport",
"type": "string"
},
{
- "description": "the gateway of the nic",
- "name": "gateway",
+ "description": "the broadcast uri of the nic",
+ "name": "broadcasturi",
+ "type": "string"
+ },
+ {
+ "description": "the traffic type of the nic",
+ "name": "traffictype",
+ "type": "string"
+ },
+ {
+ "description": "the Secondary ipv4 addr of nic",
+ "name": "secondaryip",
+ "type": "list"
+ },
+ {
+ "description": "Type of adapter if available",
+ "name": "adaptertype",
+ "type": "string"
+ },
+ {
+ "description": "the gateway of IPv6 network",
+ "name": "ip6gateway",
+ "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 cidr of IPv6 network",
+ "name": "ip6cidr",
+ "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": "IP addresses associated with NIC found for unmanaged VM",
+ "name": "ipaddresses",
+ "type": "list"
+ },
+ {
+ "description": "the ID of the corresponding network",
+ "name": "networkid",
"type": "string"
}
],
"type": "set"
},
{
- "description": "the public MAC address for the router",
- "name": "publicmacaddress",
+ "description": "the gateway for the router",
+ "name": "gateway",
"type": "string"
},
- {},
{
- "description": "the public netmask for the router",
- "name": "publicnetmask",
+ "description": "the id of the router",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "if this router is an redundant virtual router",
+ "name": "isredundantrouter",
+ "type": "boolean"
+ },
+ {
+ "description": "the Pod name for the router",
+ "name": "podname",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the corresponding public network",
+ "name": "publicnetworkid",
+ "type": "string"
+ },
+ {
+ "description": "the Zone name for the router",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the service offering of the virtual machine",
+ "name": "serviceofferingid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the corresponding guest network",
+ "name": "guestnetworkname",
+ "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": "role of the domain router",
+ "name": "role",
"type": "string"
},
{
@@ -12578,13 +12424,151 @@
"type": "string"
},
{
+ "description": "the public IP address for the router",
+ "name": "publicip",
+ "type": "string"
+ },
+ {
+ "description": "the hostname for the router",
+ "name": "hostname",
+ "type": "string"
+ },
+ {
+ "description": "the Zone ID for the router",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the first IPv6 DNS for the router",
+ "name": "ip6dns1",
+ "type": "string"
+ },
+ {
+ "description": "the name of VPC the router belongs to",
+ "name": "vpcname",
+ "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",
+ "type": "string"
+ },
+ {
+ "description": "the guest netmask for the router",
+ "name": "guestnetmask",
+ "type": "string"
+ },
+ {
+ "description": "VPC the router belongs to",
+ "name": "vpcid",
+ "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 date this VPC was created",
+ "name": "lastupdated",
+ "type": "date"
+ },
+ {
+ "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"
+ }
+ ],
+ "type": "list"
+ },
+ {
"description": "the ID of the corresponding guest network",
"name": "guestnetworkid",
"type": "string"
},
{
- "description": "the gateway for the router",
- "name": "gateway",
+ "description": "the hypervisor on which the template runs",
+ "name": "hypervisor",
+ "type": "string"
+ },
+ {
+ "description": "the Pod ID for the router",
+ "name": "podid",
+ "type": "string"
+ },
+ {
+ "description": "the second DNS for the router",
+ "name": "dns2",
+ "type": "string"
+ },
+ {
+ "description": "the version of template",
+ "name": "version",
+ "type": "string"
+ },
+ {
+ "description": "the link local MAC address for the router",
+ "name": "linklocalmacaddress",
+ "type": "string"
+ },
+ {
+ "description": "the name of the service offering of the virtual machine",
+ "name": "serviceofferingname",
+ "type": "string"
+ },
+ {
+ "description": "the guest IP address for the router",
+ "name": "guestipaddress",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID associated with the router",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the second IPv6 DNS for the router",
+ "name": "ip6dns2",
+ "type": "string"
+ },
+ {
+ "description": "the public MAC address for the router",
+ "name": "publicmacaddress",
+ "type": "string"
+ },
+ {
+ "description": "the first DNS for the router",
+ "name": "dns1",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the project id of the ipaddress",
+ "name": "projectid",
"type": "string"
},
{
@@ -12593,20 +12577,36 @@
"type": "string"
},
{
- "description": "the domain associated with the router",
- "name": "domain",
+ "description": "the project name of the address",
+ "name": "project",
"type": "string"
},
{
- "description": "the Pod name for the router",
- "name": "podname",
+ "description": "true if any health checks had failed",
+ "name": "healthchecksfailed",
+ "type": "boolean"
+ },
+ {
+ "description": "the network domain for the router",
+ "name": "networkdomain",
"type": "string"
},
{
- "description": "the Pod ID for the router",
- "name": "podid",
+ "description": "the link local netmask for the router",
+ "name": "linklocalnetmask",
"type": "string"
- }
+ },
+ {
+ "description": "the template name for the router",
+ "name": "templatename",
+ "type": "string"
+ },
+ {
+ "description": "the version of scripts",
+ "name": "scriptsversion",
+ "type": "string"
+ },
+ {}
]
},
{
@@ -12615,37 +12615,6 @@
"name": "listClusters",
"params": [
{
- "description": "lists clusters by Pod ID",
- "length": 255,
- "name": "podid",
- "related": "listPods,updatePod,createManagementNetworkIpRange",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "lists clusters by the cluster name",
- "length": 255,
- "name": "name",
- "required": false,
- "type": "string"
- },
- {
- "description": "lists clusters by the cluster ID",
- "length": 255,
- "name": "id",
- "related": "addCluster,listClusters,updateCluster",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "lists clusters by Zone ID",
- "length": 255,
- "name": "zoneid",
- "related": "createZone,updateZone,listZones,listZones",
- "required": false,
- "type": "uuid"
- },
- {
"description": "",
"length": 255,
"name": "pagesize",
@@ -12653,34 +12622,6 @@
"type": "integer"
},
{
- "description": "flag to display the capacity of the clusters",
- "length": 255,
- "name": "showcapacities",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
- },
- {
- "description": "lists clusters by hypervisor type",
- "length": 255,
- "name": "hypervisor",
- "required": false,
- "type": "string"
- },
- {
- "description": "",
- "length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
- },
- {
"description": "lists clusters by cluster type",
"length": 255,
"name": "clustertype",
@@ -12695,152 +12636,92 @@
"type": "string"
},
{
+ "description": "lists clusters by Zone ID",
+ "length": 255,
+ "name": "zoneid",
+ "related": "createZone,updateZone,listZones,listZones",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "lists clusters by allocation state",
"length": 255,
"name": "allocationstate",
"required": false,
"type": "string"
+ },
+ {
+ "description": "lists clusters by Pod ID",
+ "length": 255,
+ "name": "podid",
+ "related": "listPods,updatePod,createManagementNetworkIpRange",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "lists clusters by hypervisor type",
+ "length": 255,
+ "name": "hypervisor",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "flag to display the capacity of the clusters",
+ "length": 255,
+ "name": "showcapacities",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "lists clusters by the cluster name",
+ "length": 255,
+ "name": "name",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "lists clusters by the cluster ID",
+ "length": 255,
+ "name": "id",
+ "related": "addCluster,listClusters,updateCluster",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
}
],
"related": "addCluster,updateCluster",
"response": [
{
- "description": "the hypervisor type of the cluster",
- "name": "hypervisortype",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the Pod ID of the cluster",
- "name": "podid",
- "type": "string"
- },
- {
- "description": "the Pod name of the cluster",
- "name": "podname",
- "type": "string"
- },
- {
- "description": "the allocation state of the cluster",
- "name": "allocationstate",
- "type": "string"
- },
- {},
- {},
- {
- "description": "the type of the cluster",
- "name": "clustertype",
- "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 Zone name",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "the capacity name",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the capacity type",
- "name": "type",
- "type": "short"
- },
- {
- "description": "the capacity currently in allocated",
- "name": "capacityallocated",
- "type": "long"
- },
- {
- "description": "the Cluster name",
- "name": "clustername",
- "type": "string"
- },
- {
- "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 Pod name",
- "name": "podname",
- "type": "string"
- },
- {
- "description": "the total capacity available",
- "name": "capacitytotal",
- "type": "long"
- }
- ],
- "type": "list"
- },
- {
"description": "the cluster name",
"name": "name",
"type": "string"
},
{
- "description": "whether this cluster is managed by cloudstack",
- "name": "managedstate",
- "type": "string"
- },
- {
- "description": "The cpu overcommit ratio of the cluster",
- "name": "cpuovercommitratio",
- "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": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "The memory overcommit ratio of the cluster",
- "name": "memoryovercommitratio",
+ "description": "the Pod name of the cluster",
+ "name": "podname",
"type": "string"
},
{
- "description": "Ovm3 VIP to use for pooling and/or clustering",
- "name": "ovm3vip",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
@@ -12849,13 +12730,132 @@
"type": "map"
},
{
+ "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": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the hypervisor type of the cluster",
+ "name": "hypervisortype",
+ "type": "string"
+ },
+ {
+ "description": "the capacity of the Cluster",
+ "name": "capacity",
+ "response": [
+ {
+ "description": "the total capacity available",
+ "name": "capacitytotal",
+ "type": "long"
+ },
+ {
+ "description": "the capacity type",
+ "name": "type",
+ "type": "short"
+ },
+ {
+ "description": "the capacity currently in use",
+ "name": "capacityused",
+ "type": "long"
+ },
+ {
+ "description": "the capacity currently in allocated",
+ "name": "capacityallocated",
+ "type": "long"
+ },
+ {
+ "description": "the Pod ID",
+ "name": "podid",
+ "type": "string"
+ },
+ {
+ "description": "the Zone ID",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the capacity name",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the Cluster name",
+ "name": "clustername",
+ "type": "string"
+ },
+ {
+ "description": "the Zone name",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "the Cluster ID",
+ "name": "clusterid",
+ "type": "string"
+ },
+ {
+ "description": "the Pod name",
+ "name": "podname",
+ "type": "string"
+ },
+ {
+ "description": "the percentage of capacity currently in use",
+ "name": "percentused",
+ "type": "string"
+ }
+ ],
+ "type": "list"
+ },
+ {
+ "description": "the Pod ID of the cluster",
+ "name": "podid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "whether this cluster is managed by cloudstack",
+ "name": "managedstate",
+ "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",
+ "type": "string"
+ },
+ {
+ "description": "The memory overcommit ratio of the cluster",
+ "name": "memoryovercommitratio",
+ "type": "string"
+ },
+ {
"description": "the cluster ID",
"name": "id",
"type": "string"
},
{
- "description": "the Zone ID of the cluster",
- "name": "zoneid",
+ "description": "the type of the cluster",
+ "name": "clustertype",
+ "type": "string"
+ },
+ {
+ "description": "The cpu overcommit ratio of the cluster",
+ "name": "cpuovercommitratio",
"type": "string"
}
]
@@ -12876,9 +12876,9 @@
],
"response": [
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "any text associated with the success or failure",
+ "name": "displaytext",
+ "type": "string"
},
{
"description": "the UUID of the latest async job acting on this object",
@@ -12886,17 +12886,17 @@
"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"
},
@@ -12906,35 +12906,27 @@
"name": "listProjectInvitations",
"params": [
{
- "description": "list invitations by state",
+ "description": "list resources by account. Must be used with the domainId parameter.",
"length": 255,
- "name": "state",
+ "name": "account",
"required": false,
"type": "string"
},
{
- "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false",
+ "description": "List by keyword",
"length": 255,
- "name": "listall",
+ "name": "keyword",
+ "required": false,
+ "type": "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,
- "name": "page",
- "required": false,
- "type": "integer"
- },
- {
- "description": "list by project id",
- "length": 255,
- "name": "projectid",
- "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject",
- "required": false,
- "type": "uuid"
- },
- {
"description": "list invitations by id",
"length": 255,
"name": "id",
@@ -12950,138 +12942,10 @@
"type": "integer"
},
{
- "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
+ "description": "list by project id",
"length": 255,
- "name": "isrecursive",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "list resources by account. Must be used with the domainId parameter.",
- "length": 255,
- "name": "account",
- "required": false,
- "type": "string"
- },
- {
- "description": "list invitation by user ID",
- "length": 255,
- "name": "userid",
- "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "list only resources belonging to the domain specified",
- "length": 255,
- "name": "domainid",
- "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
- },
- {
- "description": "if true, list only active invitations - having Pending state and ones that are not timed out yet",
- "length": 255,
- "name": "activeonly",
- "required": false,
- "type": "boolean"
- }
- ],
- "related": "",
- "response": [
- {},
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the domain id the project belongs to",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the User ID",
- "name": "userid",
- "type": "string"
- },
- {},
- {
- "description": "the email the invitation was sent to",
- "name": "email",
- "type": "string"
- },
- {
- "description": "the account name of the project's owner",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the domain name where the project belongs to",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the id of the invitation",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the invitation state",
- "name": "state",
- "type": "string"
- },
- {
- "description": "the name of the project",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the id of the project",
"name": "projectid",
- "type": "string"
- }
- ],
- "since": "3.0.0"
- },
- {
- "description": "Lists all egress firewall rules for network ID.",
- "isasync": false,
- "name": "listEgressFirewallRules",
- "params": [
- {
- "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter",
- "length": 255,
- "name": "fordisplay",
- "required": false,
- "since": "4.4",
- "type": "boolean"
- },
- {
- "description": "Lists rule with the specified ID.",
- "length": 255,
- "name": "id",
- "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "the ID of IP address of the firewall services",
- "length": 255,
- "name": "ipaddressid",
- "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses",
+ "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject",
"required": false,
"type": "uuid"
},
@@ -13101,26 +12965,117 @@
"type": "uuid"
},
{
- "description": "List resources by tags (key/value pairs)",
+ "description": "list invitation by user ID",
"length": 255,
- "name": "tags",
- "required": false,
- "type": "map"
- },
- {
- "description": "the network ID for the egress firewall services",
- "length": 255,
- "name": "networkid",
- "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks",
+ "name": "userid",
+ "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser",
"required": false,
"type": "uuid"
},
{
+ "description": "if true, list only active invitations - having Pending state and ones that are not timed out yet",
+ "length": 255,
+ "name": "activeonly",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "list invitations by state",
+ "length": 255,
+ "name": "state",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "",
"length": 255,
- "name": "pagesize",
+ "name": "page",
"required": false,
"type": "integer"
+ }
+ ],
+ "related": "",
+ "response": [
+ {},
+ {
+ "description": "the id of the invitation",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the id of the project",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the email the invitation was sent to",
+ "name": "email",
+ "type": "string"
+ },
+ {
+ "description": "the invitation state",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the User ID",
+ "name": "userid",
+ "type": "string"
+ },
+ {
+ "description": "the domain name where the project belongs to",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the name of the project",
+ "name": "project",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the account name of the project's owner",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the domain id the project belongs to",
+ "name": "domainid",
+ "type": "string"
+ }
+ ],
+ "since": "3.0.0"
+ },
+ {
+ "description": "Lists all egress firewall rules for network ID.",
+ "isasync": false,
+ "name": "listEgressFirewallRules",
+ "params": [
+ {
+ "description": "list only resources belonging to the domain specified",
+ "length": 255,
+ "name": "domainid",
+ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
+ "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": "",
@@ -13130,12 +13085,18 @@
"type": "integer"
},
{
- "description": "list objects by project",
+ "description": "If set to false, list only 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": "projectid",
- "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject",
+ "name": "listall",
"required": false,
- "type": "uuid"
+ "type": "boolean"
+ },
+ {
+ "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.",
@@ -13152,21 +13113,75 @@
"type": "string"
},
{
- "description": "list resources by account. Must be used with the domainId parameter.",
+ "description": "the network ID for the egress firewall services",
"length": 255,
- "name": "account",
+ "name": "networkid",
+ "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks",
"required": false,
- "type": "string"
+ "type": "uuid"
+ },
+ {
+ "description": "List resources by tags (key/value pairs)",
+ "length": 255,
+ "name": "tags",
+ "required": false,
+ "type": "map"
+ },
+ {
+ "description": "the ID of IP address of the firewall services",
+ "length": 255,
+ "name": "ipaddressid",
+ "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "list objects by project",
+ "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": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules",
+ "required": false,
+ "type": "uuid"
}
],
"related": "createFirewallRule,listFirewallRules,updateEgressFirewallRule",
"response": [
{
- "description": "the ID of the firewall rule",
- "name": "id",
+ "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 cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).",
+ "name": "destcidrlist",
"type": "string"
},
{
+ "description": "the starting port of firewall rule's port range",
+ "name": "startport",
+ "type": "integer"
+ },
+ {
"description": "the public ip address for the firewall rule",
"name": "ipaddress",
"type": "string"
@@ -13176,43 +13191,23 @@
"name": "tags",
"response": [
{
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
"description": "tag key name",
"name": "key",
"type": "string"
},
{
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "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 project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
+ "description": "id of the resource",
+ "name": "resourceid",
"type": "string"
},
{
@@ -13221,34 +13216,34 @@
"type": "string"
},
{
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
"description": "customer associated with the tag",
"name": "customer",
"type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the 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 starting port of firewall rule's port range",
- "name": "startport",
- "type": "integer"
- },
- {
- "description": "the state of the rule",
- "name": "state",
- "type": "string"
- },
- {
- "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).",
- "name": "cidrlist",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
"description": "the network id of the firewall rule",
"name": "networkid",
"type": "string"
@@ -13258,9 +13253,10 @@
"name": "icmptype",
"type": "integer"
},
+ {},
{
- "description": "the public ip address id for the firewall rule",
- "name": "ipaddressid",
+ "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).",
+ "name": "cidrlist",
"type": "string"
},
{
@@ -13269,13 +13265,18 @@
"type": "integer"
},
{
+ "description": "the state of the rule",
+ "name": "state",
+ "type": "string"
+ },
+ {
"description": "error code for this icmp message",
"name": "icmpcode",
"type": "integer"
},
{
- "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).",
- "name": "destcidrlist",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
@@ -13285,16 +13286,15 @@
},
{},
{
- "description": "is rule for display to the regular user",
- "name": "fordisplay",
- "type": "boolean"
+ "description": "the ID of the firewall rule",
+ "name": "id",
+ "type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {}
+ "description": "the public ip address id for the firewall rule",
+ "name": "ipaddressid",
+ "type": "string"
+ }
]
},
{
@@ -13331,16 +13331,7 @@
"name": "gslbserviceenabled",
"type": "boolean"
},
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the end point of the region",
- "name": "endpoint",
- "type": "string"
- },
+ {},
{},
{
"description": "the name of the region",
@@ -13353,6 +13344,16 @@
"type": "integer"
},
{
+ "description": "the end point of the region",
+ "name": "endpoint",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
@@ -13361,8 +13362,7 @@
"description": "true if security groups support is enabled, false otherwise",
"name": "portableipserviceenabled",
"type": "boolean"
- },
- {}
+ }
]
},
{
@@ -13381,27 +13381,27 @@
],
"response": [
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
"description": "true if operation is executed successfully",
"name": "success",
"type": "boolean"
},
- {
- "description": "any text associated with the success or failure",
- "name": "displaytext",
- "type": "string"
- },
+ {},
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
{},
- {}
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "any text associated with the success or failure",
+ "name": "displaytext",
+ "type": "string"
+ }
],
"since": "3.0.0"
},
@@ -13411,43 +13411,6 @@
"name": "listClustersMetrics",
"params": [
{
- "description": "",
- "length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
- },
- {
- "description": "whether this cluster is managed by cloudstack",
- "length": 255,
- "name": "managedstate",
- "required": false,
- "type": "string"
- },
- {
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
- },
- {
- "description": "lists clusters by the cluster ID",
- "length": 255,
- "name": "id",
- "related": "addCluster,updateCluster",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "lists clusters by Zone ID",
- "length": 255,
- "name": "zoneid",
- "related": "createZone,updateZone,listZones,listZones",
- "required": false,
- "type": "uuid"
- },
- {
"description": "flag to display the capacity of the clusters",
"length": 255,
"name": "showcapacities",
@@ -13462,6 +13425,51 @@
"type": "string"
},
{
+ "description": "lists clusters by Pod ID",
+ "length": 255,
+ "name": "podid",
+ "related": "listPods,updatePod,createManagementNetworkIpRange",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "whether this cluster is managed by cloudstack",
+ "length": 255,
+ "name": "managedstate",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "lists clusters by the cluster ID",
+ "length": 255,
+ "name": "id",
+ "related": "addCluster,updateCluster",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "lists clusters by Zone ID",
+ "length": 255,
+ "name": "zoneid",
+ "related": "createZone,updateZone,listZones,listZones",
+ "required": false,
+ "type": "uuid"
+ },
+ {
"description": "",
"length": 255,
"name": "page",
@@ -13469,6 +13477,13 @@
"type": "integer"
},
{
+ "description": "lists clusters by the cluster name",
+ "length": 255,
+ "name": "name",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "lists clusters by allocation state",
"length": 255,
"name": "allocationstate",
@@ -13476,245 +13491,26 @@
"type": "string"
},
{
- "description": "lists clusters by Pod ID",
- "length": 255,
- "name": "podid",
- "related": "listPods,updatePod,createManagementNetworkIpRange",
- "required": false,
- "type": "uuid"
- },
- {
"description": "lists clusters by cluster type",
"length": 255,
"name": "clustertype",
"required": false,
"type": "string"
- },
- {
- "description": "lists clusters by the cluster name",
- "length": 255,
- "name": "name",
- "required": false,
- "type": "string"
}
],
"related": "",
"response": [
{
- "description": "memory allocated notification threshold exceeded",
- "name": "memoryallocatedthreshold",
- "type": "boolean"
- },
- {
- "description": "the total cpu used in GiB",
- "name": "memoryused",
- "type": "string"
- },
- {
- "description": "running / total hosts in the cluster",
- "name": "hosts",
- "type": "string"
- },
- {},
- {
- "description": "the total cpu used in Ghz",
- "name": "cpuused",
- "type": "string"
- },
- {
- "description": "cpu usage notification threshold exceeded",
- "name": "cputhreshold",
- "type": "boolean"
- },
- {
- "description": "cpu allocated notification threshold exceeded",
- "name": "cpuallocatedthreshold",
- "type": "boolean"
- },
- {
- "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": "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",
- "type": "string"
- },
- {
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
"description": "the maximum cpu deviation",
"name": "cpumaxdeviation",
"type": "string"
},
{
- "description": "memory allocated disable threshold exceeded",
- "name": "memoryallocateddisablethreshold",
+ "description": "memory usage notification threshold exceeded",
+ "name": "memorythreshold",
"type": "boolean"
},
{
- "description": "the cluster ID",
- "name": "id",
- "type": "string"
- },
- {
- "description": "whether this cluster is managed by cloudstack",
- "name": "managedstate",
- "type": "string"
- },
- {
- "description": "state of the cluster",
- "name": "state",
- "type": "string"
- },
- {
- "description": "the Zone ID of the cluster",
- "name": "zoneid",
- "type": "string"
- },
- {
- "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",
- "type": "string"
- },
- {
- "description": "the total cpu capacity in Ghz",
- "name": "cputotal",
- "type": "string"
- },
- {
- "description": "the Zone name of the cluster",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "The memory overcommit ratio of the cluster",
- "name": "memoryovercommitratio",
- "type": "string"
- },
- {
- "description": "the total cpu allocated in GiB",
- "name": "memoryallocated",
- "type": "string"
- },
- {
- "description": "the total cpu allocated in Ghz",
- "name": "cpuallocated",
- "type": "string"
- },
- {
- "description": "the type of the cluster",
- "name": "clustertype",
- "type": "string"
- },
- {
- "description": "cpu allocated disable threshold exceeded",
- "name": "cpuallocateddisablethreshold",
- "type": "boolean"
- },
- {
- "description": "cpu usage disable threshold exceeded",
- "name": "cpudisablethreshold",
- "type": "boolean"
- },
- {
- "description": "the capacity of the Cluster",
- "name": "capacity",
- "response": [
- {
- "description": "the total capacity available",
- "name": "capacitytotal",
- "type": "long"
- },
- {
- "description": "the capacity type",
- "name": "type",
- "type": "short"
- },
- {
- "description": "the Cluster ID",
- "name": "clusterid",
- "type": "string"
- },
- {
- "description": "the capacity currently in use",
- "name": "capacityused",
- "type": "long"
- },
- {
- "description": "the Zone name",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "the capacity name",
- "name": "name",
- "type": "string"
- },
- {
- "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 capacity currently in allocated",
- "name": "capacityallocated",
- "type": "long"
- },
- {
- "description": "the Cluster name",
- "name": "clustername",
- "type": "string"
- },
- {
- "description": "the percentage of capacity currently in use",
- "name": "percentused",
- "type": "string"
- }
- ],
- "type": "list"
- },
- {
- "description": "the hypervisor type of the cluster",
- "name": "hypervisortype",
- "type": "string"
- },
- {
- "description": "memory usage disable threshold exceeded",
- "name": "memorydisablethreshold",
- "type": "boolean"
- },
- {},
- {
"description": "The cpu overcommit ratio of the cluster",
"name": "cpuovercommitratio",
"type": "string"
@@ -13725,13 +13521,13 @@
"type": "string"
},
{
- "description": "memory usage notification threshold exceeded",
- "name": "memorythreshold",
- "type": "boolean"
+ "description": "state of the cluster",
+ "name": "state",
+ "type": "string"
},
{
- "description": "the allocation state of the cluster",
- "name": "allocationstate",
+ "description": "whether this cluster is managed by cloudstack",
+ "name": "managedstate",
"type": "string"
},
{
@@ -13740,9 +13536,213 @@
"type": "string"
},
{
+ "description": "the Pod ID of the cluster",
+ "name": "podid",
+ "type": "string"
+ },
+ {
+ "description": "running / total hosts in the cluster",
+ "name": "hosts",
+ "type": "string"
+ },
+ {
+ "description": "the total cpu capacity in Ghz",
+ "name": "cputotal",
+ "type": "string"
+ },
+ {},
+ {
+ "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 total cpu used in Ghz",
+ "name": "cpuused",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the total cpu used in GiB",
+ "name": "memoryused",
+ "type": "string"
+ },
+ {
+ "description": "cpu allocated notification threshold exceeded",
+ "name": "cpuallocatedthreshold",
+ "type": "boolean"
+ },
+ {
+ "description": "the capacity of the Cluster",
+ "name": "capacity",
+ "response": [
+ {
+ "description": "the percentage of capacity currently in use",
+ "name": "percentused",
+ "type": "string"
+ },
+ {
+ "description": "the capacity currently in use",
+ "name": "capacityused",
+ "type": "long"
+ },
+ {
+ "description": "the Pod ID",
+ "name": "podid",
+ "type": "string"
+ },
+ {
+ "description": "the total capacity available",
+ "name": "capacitytotal",
+ "type": "long"
+ },
+ {
+ "description": "the capacity type",
+ "name": "type",
+ "type": "short"
+ },
+ {
+ "description": "the capacity name",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the Zone name",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "the Pod name",
+ "name": "podname",
+ "type": "string"
+ },
+ {
+ "description": "the Cluster ID",
+ "name": "clusterid",
+ "type": "string"
+ },
+ {
+ "description": "the Zone ID",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the Cluster name",
+ "name": "clustername",
+ "type": "string"
+ },
+ {
+ "description": "the capacity currently in allocated",
+ "name": "capacityallocated",
+ "type": "long"
+ }
+ ],
+ "type": "list"
+ },
+ {
+ "description": "the Zone name of the cluster",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "cpu allocated disable threshold exceeded",
+ "name": "cpuallocateddisablethreshold",
+ "type": "boolean"
+ },
+ {
+ "description": "memory allocated disable threshold exceeded",
+ "name": "memoryallocateddisablethreshold",
+ "type": "boolean"
+ },
+ {
+ "description": "the type of the cluster",
+ "name": "clustertype",
+ "type": "string"
+ },
+ {
+ "description": "the hypervisor type of the cluster",
+ "name": "hypervisortype",
+ "type": "string"
+ },
+ {
+ "description": "cpu usage disable threshold exceeded",
+ "name": "cpudisablethreshold",
+ "type": "boolean"
+ },
+ {
+ "description": "The memory overcommit ratio of the cluster",
+ "name": "memoryovercommitratio",
+ "type": "string"
+ },
+ {
+ "description": "Meta data associated with the zone (key/value pairs)",
+ "name": "resourcedetails",
+ "type": "map"
+ },
+ {
+ "description": "the Zone ID of the cluster",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
"description": "the maximum memory deviation",
"name": "memorymaxdeviation",
"type": "string"
+ },
+ {
+ "description": "Ovm3 VIP to use for pooling and/or clustering",
+ "name": "ovm3vip",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the cluster ID",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "memory usage disable threshold exceeded",
+ "name": "memorydisablethreshold",
+ "type": "boolean"
+ },
+ {
+ "description": "the total cpu allocated in Ghz",
+ "name": "cpuallocated",
+ "type": "string"
+ },
+ {
+ "description": "the Pod name of the cluster",
+ "name": "podname",
+ "type": "string"
+ },
+ {
+ "description": "memory allocated notification threshold exceeded",
+ "name": "memoryallocatedthreshold",
+ "type": "boolean"
+ },
+ {
+ "description": "the total cpu allocated in GiB",
+ "name": "memoryallocated",
+ "type": "string"
+ },
+ {
+ "description": "cpu usage notification threshold exceeded",
+ "name": "cputhreshold",
+ "type": "boolean"
}
],
"since": "4.9.3"
@@ -13772,8 +13772,8 @@
"related": "createProjectRolePermission",
"response": [
{
- "description": "the api name or wildcard rule",
- "name": "rule",
+ "description": "the ID of the project role to which the role permission belongs",
+ "name": "projectroleid",
"type": "string"
},
{
@@ -13782,42 +13782,42 @@
"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 permission",
"name": "id",
"type": "string"
},
- {
- "description": "the ID of the project role to which the role permission belongs",
- "name": "projectroleid",
- "type": "string"
- },
- {
- "description": "the name of the project role to which the role permission belongs",
- "name": "projectrolename",
- "type": "string"
- },
{},
{
- "description": "the permission type of the api name or wildcard rule, allow/deny",
- "name": "permission",
- "type": "string"
- },
- {
- "description": "the description of the role permission",
- "name": "description",
- "type": "string"
- },
- {
"description": "the UUID of the latest async job acting on 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 api name or wildcard rule",
+ "name": "rule",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the name of the project role to which the role permission belongs",
+ "name": "projectrolename",
+ "type": "string"
+ },
+ {
+ "description": "the description of the role permission",
+ "name": "description",
+ "type": "string"
+ }
],
"since": "4.15.0"
},
@@ -13827,6 +13827,20 @@
"name": "listLdapConfigurations",
"params": [
{
+ "description": "Hostname",
+ "length": 255,
+ "name": "hostname",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "Port",
+ "length": 255,
+ "name": "port",
+ "required": false,
+ "type": "integer"
+ },
+ {
"description": "List by keyword",
"length": 255,
"name": "keyword",
@@ -13841,12 +13855,11 @@
"type": "integer"
},
{
- "description": "linked domain",
+ "description": "",
"length": 255,
- "name": "domainid",
- "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
+ "name": "page",
"required": false,
- "type": "uuid"
+ "type": "integer"
},
{
"description": "If set to true, and no domainid specified, list all LDAP configurations irrespective of the linked domain",
@@ -13857,29 +13870,26 @@
"type": "boolean"
},
{
- "description": "Port",
+ "description": "linked domain",
"length": 255,
- "name": "port",
+ "name": "domainid",
+ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
"required": false,
- "type": "integer"
- },
- {
- "description": "",
- "length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
- },
- {
- "description": "Hostname",
- "length": 255,
- "name": "hostname",
- "required": false,
- "type": "string"
+ "type": "uuid"
}
],
"related": "addLdapConfiguration,deleteLdapConfiguration",
"response": [
+ {
+ "description": "port teh ldap server is running on",
+ "name": "port",
+ "type": "int"
+ },
+ {
+ "description": "linked domain",
+ "name": "domainid",
+ "type": "string"
+ },
{},
{
"description": "the current status of the latest async job acting on this object",
@@ -13891,16 +13901,6 @@
"name": "jobid",
"type": "string"
},
- {
- "description": "port teh ldap server is running on",
- "name": "port",
- "type": "int"
- },
- {
- "description": "linked domain",
- "name": "domainid",
- "type": "string"
- },
{},
{
"description": "name of the host running the ldap server",
@@ -13916,9 +13916,9 @@
"name": "listSecondaryStagingStores",
"params": [
{
- "description": "the name of the staging store",
+ "description": "the staging store protocol",
"length": 255,
- "name": "name",
+ "name": "protocol",
"required": false,
"type": "string"
},
@@ -13931,24 +13931,9 @@
"type": "uuid"
},
{
- "description": "the ID of the staging store",
+ "description": "the name of the staging store",
"length": 255,
- "name": "id",
- "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,listSecondaryStagingStores,updateCloudToUseObjectStore",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "",
- "length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
- },
- {
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
+ "name": "name",
"required": false,
"type": "string"
},
@@ -13960,16 +13945,31 @@
"type": "integer"
},
{
- "description": "the staging store provider",
+ "description": "",
"length": 255,
- "name": "provider",
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "the ID of the staging store",
+ "length": 255,
+ "name": "id",
+ "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,listSecondaryStagingStores,updateCloudToUseObjectStore",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
"required": false,
"type": "string"
},
{
- "description": "the staging store protocol",
+ "description": "the staging store provider",
"length": 255,
- "name": "protocol",
+ "name": "provider",
"required": false,
"type": "string"
}
@@ -13977,55 +13977,26 @@
"related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,updateCloudToUseObjectStore",
"response": [
{
- "description": "the provider name of the image store",
- "name": "providername",
+ "description": "the name of the image store",
+ "name": "name",
"type": "string"
},
- {
- "description": "the url of the image store",
- "name": "url",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
+ {},
{
"description": "the host's currently used disk size",
"name": "disksizeused",
"type": "long"
},
- {
- "description": "the ID of the image store",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the name of the image store",
- "name": "name",
- "type": "string"
- },
+ {},
{
"description": "the Zone ID of the image store",
"name": "zoneid",
"type": "string"
},
{
- "description": "the total disk size of the host",
- "name": "disksizetotal",
- "type": "long"
- },
- {},
- {
- "description": "the 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 protocol of the image store",
+ "name": "protocol",
+ "type": "string"
},
{
"description": "the Zone name of the image store",
@@ -14038,16 +14009,45 @@
"type": "boolean"
},
{
+ "description": "the ID of the image store",
+ "name": "id",
+ "type": "string"
+ },
+ {
"description": "the scope of the image store",
"name": "scope",
"type": "scopetype"
},
{
- "description": "the protocol of the image store",
- "name": "protocol",
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
- {}
+ {
+ "description": "the total disk size of the host",
+ "name": "disksizetotal",
+ "type": "long"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the provider name of the image store",
+ "name": "providername",
+ "type": "string"
+ },
+ {
+ "description": "the url of the image store",
+ "name": "url",
+ "type": "string"
+ }
],
"since": "4.2.0"
},
@@ -14064,6 +14064,20 @@
"type": "string"
},
{
+ "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitely. Has value true by default",
+ "length": 255,
+ "name": "openfirewall",
+ "required": false,
+ "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",
+ "length": 255,
+ "name": "iprange",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "an optional field, whether to the display the vpn to the end user or not",
"length": 255,
"name": "fordisplay",
@@ -14072,14 +14086,6 @@
"type": "boolean"
},
{
- "description": "an optional domainId for the VPN. If the account parameter is used, domainId must also be used.",
- "length": 255,
- "name": "domainid",
- "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
- "required": false,
- "type": "uuid"
- },
- {
"description": "public ip address id of the vpn server",
"length": 255,
"name": "publicipid",
@@ -14088,33 +14094,22 @@
"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",
+ "description": "an optional domainId for the VPN. If the account parameter is used, domainId must also be used.",
"length": 255,
- "name": "iprange",
+ "name": "domainid",
+ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
"required": false,
- "type": "string"
- },
- {
- "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitely. Has value true by default",
- "length": 255,
- "name": "openfirewall",
- "required": false,
- "type": "boolean"
+ "type": "uuid"
}
],
"related": "listRemoteAccessVpns,updateRemoteAccessVpn",
"response": [
{
- "description": "the domain name of the account of the remote access vpn",
- "name": "domain",
+ "description": "the project id of the vpn",
+ "name": "projectid",
"type": "string"
},
{
- "description": "is vpn for display to the regular user",
- "name": "fordisplay",
- "type": "boolean"
- },
- {
"description": "the project name of the vpn",
"name": "project",
"type": "string"
@@ -14124,41 +14119,19 @@
"name": "publicipid",
"type": "string"
},
- {},
- {
- "description": "the state of the rule",
- "name": "state",
- "type": "string"
- },
- {
- "description": "the project id of the vpn",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the id of the remote access vpn",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the account of the remote access vpn",
- "name": "account",
- "type": "string"
- },
- {},
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
{
- "description": "the ipsec preshared key",
- "name": "presharedkey",
- "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",
+ "description": "the ipsec preshared key",
+ "name": "presharedkey",
"type": "string"
},
{
@@ -14172,9 +14145,36 @@
"type": "string"
},
{
+ "description": "the domain name of the account of the remote access vpn",
+ "name": "domain",
+ "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 account of the remote access vpn",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the id of the remote access vpn",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the public ip address of the vpn server",
+ "name": "publicip",
+ "type": "string"
}
]
},
@@ -14195,29 +14195,9 @@
"related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx",
"response": [
{
- "description": "the domain ID associated with the router",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the network domain for the router",
- "name": "networkdomain",
- "type": "string"
- },
- {
- "description": "the name of the corresponding guest network",
- "name": "guestnetworkname",
- "type": "string"
- },
- {
- "description": "the template name for the router",
- "name": "templatename",
- "type": "string"
- },
- {
- "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 link local IP address for the router",
@@ -14225,48 +14205,13 @@
"type": "string"
},
{
- "description": "the second IPv6 DNS for the router",
- "name": "ip6dns2",
- "type": "string"
- },
- {
- "description": "the version of scripts",
- "name": "scriptsversion",
- "type": "string"
- },
- {
- "description": "the name of the router",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the link local netmask for the router",
- "name": "linklocalnetmask",
- "type": "string"
- },
- {
"description": "the host ID for the router",
"name": "hostid",
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the account associated with the router",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the guest netmask for the router",
- "name": "guestnetmask",
- "type": "string"
- },
- {
- "description": "the state of redundant virtual router",
- "name": "redundantstate",
+ "description": "the guest MAC address for the router",
+ "name": "guestmacaddress",
"type": "string"
},
{
@@ -14274,278 +14219,84 @@
"name": "guestipaddress",
"type": "string"
},
- {},
{
"description": "the ID of the corresponding link local network",
"name": "linklocalnetworkid",
"type": "string"
},
{
- "description": "the gateway for the router",
- "name": "gateway",
- "type": "string"
- },
- {
- "description": "the guest MAC address for the router",
- "name": "guestmacaddress",
- "type": "string"
- },
- {
- "description": "the id of the router",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the Zone ID for the router",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the name of VPC the router belongs to",
- "name": "vpcname",
- "type": "string"
- },
- {
- "description": "the Pod ID for the router",
- "name": "podid",
- "type": "string"
- },
- {
- "description": "role of the domain router",
- "name": "role",
- "type": "string"
- },
- {
- "description": "VPC the router belongs to",
- "name": "vpcid",
- "type": "string"
- },
- {
- "description": "the public netmask for the router",
- "name": "publicnetmask",
- "type": "string"
- },
- {},
- {
- "description": "the domain associated with the router",
- "name": "domain",
- "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": "true if the router template requires upgrader",
- "name": "requiresupgrade",
- "type": "boolean"
- },
- {
- "description": "the project name of the address",
- "name": "project",
- "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"
+ },
+ {
+ "description": "the second IPv6 DNS for the router",
+ "name": "ip6dns2",
+ "type": "string"
+ },
+ {
"description": "if this router is an redundant virtual router",
"name": "isredundantrouter",
"type": "boolean"
},
{
- "description": "the ID of the corresponding public network",
- "name": "publicnetworkid",
+ "description": "the ID of the service offering of the virtual machine",
+ "name": "serviceofferingid",
"type": "string"
},
{
- "description": "the link local MAC address for the router",
- "name": "linklocalmacaddress",
+ "description": "the domain associated with the router",
+ "name": "domain",
"type": "string"
},
{
- "description": "the first DNS for the router",
- "name": "dns1",
+ "description": "the version of template",
+ "name": "version",
"type": "string"
},
{
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "true if any health checks had failed",
- "name": "healthchecksfailed",
- "type": "boolean"
- },
- {
- "description": "the Pod name for the router",
- "name": "podname",
- "type": "string"
- },
- {
- "description": "the public MAC address for the router",
- "name": "publicmacaddress",
- "type": "string"
- },
- {
- "description": "the public IP address for the router",
- "name": "publicip",
- "type": "string"
- },
- {
- "description": "the list of nics associated with the router",
- "name": "nic",
- "response": [
- {
- "description": "the Secondary ipv4 addr of nic",
- "name": "secondaryip",
- "type": "list"
- },
- {
- "description": "the isolation uri of the nic",
- "name": "isolationuri",
- "type": "string"
- },
- {
- "description": "ID of the VLAN/VNI if available",
- "name": "vlanid",
- "type": "integer"
- },
- {
- "description": "the gateway of the nic",
- "name": "gateway",
- "type": "string"
- },
- {
- "description": "the isolated private VLAN type if available",
- "name": "isolatedpvlantype",
- "type": "string"
- },
- {
- "description": "the type of the nic",
- "name": "type",
- "type": "string"
- },
- {
- "description": "Type of adapter if available",
- "name": "adaptertype",
- "type": "string"
- },
- {
- "description": "the ID of the corresponding network",
- "name": "networkid",
- "type": "string"
- },
- {
- "description": "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": "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 name of the corresponding network",
- "name": "networkname",
- "type": "string"
- },
- {
- "description": "the isolated private VLAN if available",
- "name": "isolatedpvlan",
- "type": "integer"
- },
- {
- "description": "the ip address of the nic",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "description": "the 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 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": "IP addresses associated with NIC found for unmanaged VM",
- "name": "ipaddresses",
- "type": "list"
- },
- {
- "description": "the ID of the nic",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the traffic type of the nic",
- "name": "traffictype",
- "type": "string"
- },
- {
- "description": "the extra dhcp options on the nic",
- "name": "extradhcpoption",
- "type": "list"
- },
- {
- "description": "the broadcast uri of the nic",
- "name": "broadcasturi",
- "type": "string"
- },
- {
- "description": "the gateway of IPv6 network",
- "name": "ip6gateway",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
"description": "the ID of the corresponding guest network",
"name": "guestnetworkid",
"type": "string"
},
{
- "description": "the project id of the ipaddress",
- "name": "projectid",
+ "description": "the domain ID associated with the router",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "true if any health checks had failed",
+ "name": "healthchecksfailed",
+ "type": "boolean"
+ },
+ {
+ "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": "true if the router template requires upgrader",
+ "name": "requiresupgrade",
+ "type": "boolean"
+ },
+ {
+ "description": "the template name for the router",
+ "name": "templatename",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the router",
+ "name": "account",
"type": "string"
},
{
@@ -14554,18 +14305,246 @@
"type": "string"
},
{
- "description": "the date and time the router was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the version of template",
- "name": "version",
+ "description": "the id of the router",
+ "name": "id",
"type": "string"
},
{
- "description": "the Zone name for the router",
- "name": "zonename",
+ "description": "the public netmask for the router",
+ "name": "publicnetmask",
+ "type": "string"
+ },
+ {
+ "description": "the name of the router",
+ "name": "name",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the link local netmask for the router",
+ "name": "linklocalnetmask",
+ "type": "string"
+ },
+ {
+ "description": "the project id of the ipaddress",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the Pod name for the router",
+ "name": "podname",
+ "type": "string"
+ },
+ {
+ "description": "the Zone ID for the router",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the template ID for the router",
+ "name": "templateid",
+ "type": "string"
+ },
+ {
+ "description": "the public MAC address for the router",
+ "name": "publicmacaddress",
+ "type": "string"
+ },
+ {
+ "description": "the list of nics associated with the router",
+ "name": "nic",
+ "response": [
+ {
+ "description": "true if nic is default, false otherwise",
+ "name": "macaddress",
+ "type": "string"
+ },
+ {
+ "description": "Id of the vm to which the nic belongs",
+ "name": "virtualmachineid",
+ "type": "string"
+ },
+ {
+ "description": "the 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": "true if nic is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {
+ "description": "the gateway of the nic",
+ "name": "gateway",
+ "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": "ID of the VLAN/VNI if available",
+ "name": "vlanid",
+ "type": "integer"
+ },
+ {
+ "description": "the isolated private VLAN type if available",
+ "name": "isolatedpvlantype",
+ "type": "string"
+ },
+ {
+ "description": "the traffic type of the nic",
+ "name": "traffictype",
+ "type": "string"
+ },
+ {
+ "description": "the broadcast uri of the nic",
+ "name": "broadcasturi",
+ "type": "string"
+ },
+ {
+ "description": "Id of the NSX Logical Switch (if NSX based), null otherwise",
+ "name": "nsxlogicalswitch",
+ "type": "string"
+ },
+ {
+ "description": "Type of adapter if available",
+ "name": "adaptertype",
+ "type": "string"
+ },
+ {
+ "description": "the name of the corresponding network",
+ "name": "networkname",
+ "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 NSX Logical Switch Port (if NSX based), null otherwise",
+ "name": "nsxlogicalswitchport",
+ "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": "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 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 nic",
+ "name": "id",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the state of the router",
+ "name": "state",
+ "type": "state"
+ },
+ {
+ "description": "the name of the corresponding guest network",
+ "name": "guestnetworkname",
+ "type": "string"
+ },
+ {
+ "description": "the Pod ID for the router",
+ "name": "podid",
+ "type": "string"
+ },
+ {
+ "description": "VPC the router belongs to",
+ "name": "vpcid",
+ "type": "string"
+ },
+ {
+ "description": "the first DNS for the router",
+ "name": "dns1",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the corresponding public network",
+ "name": "publicnetworkid",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the address",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the name of the service offering of the virtual machine",
+ "name": "serviceofferingname",
+ "type": "string"
+ },
+ {
+ "description": "the state of redundant virtual router",
+ "name": "redundantstate",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the link local MAC address for the router",
+ "name": "linklocalmacaddress",
+ "type": "string"
+ },
+ {
+ "description": "the network domain for the router",
+ "name": "networkdomain",
"type": "string"
},
{
@@ -14573,6 +14552,16 @@
"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 type of the health check - basic or advanced",
"name": "checktype",
"type": "string"
@@ -14586,39 +14575,50 @@
"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",
- "type": "string"
}
],
"type": "list"
},
{
+ "description": "the name of VPC the router belongs to",
+ "name": "vpcname",
+ "type": "string"
+ },
+ {
"description": "the first IPv6 DNS for the router",
"name": "ip6dns1",
"type": "string"
},
{
- "description": "the name of the service offering of the virtual machine",
- "name": "serviceofferingname",
+ "description": "role of the domain router",
+ "name": "role",
"type": "string"
},
{
- "description": "the template ID for the router",
- "name": "templateid",
+ "description": "the hypervisor on which the template runs",
+ "name": "hypervisor",
"type": "string"
},
{
- "description": "the state of the router",
- "name": "state",
- "type": "state"
+ "description": "the public IP address for the router",
+ "name": "publicip",
+ "type": "string"
+ },
+ {
+ "description": "the gateway for the router",
+ "name": "gateway",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the guest netmask for the router",
+ "name": "guestnetmask",
+ "type": "string"
+ },
+ {
+ "description": "the version of scripts",
+ "name": "scriptsversion",
+ "type": "string"
}
]
},
@@ -14635,88 +14635,27 @@
"type": "map"
},
{
- "description": "the service offering ID to apply to the virtual machine",
- "length": 255,
- "name": "serviceofferingid",
- "related": "createServiceOffering,updateServiceOffering,listServiceOfferings",
- "required": true,
- "type": "uuid"
- },
- {
"description": "The ID of the virtual machine",
"length": 255,
"name": "id",
"related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,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",
"required": true,
"type": "uuid"
+ },
+ {
+ "description": "the service offering ID to apply to the virtual machine",
+ "length": 255,
+ "name": "serviceofferingid",
+ "related": "createServiceOffering,updateServiceOffering,listServiceOfferings",
+ "required": true,
+ "type": "uuid"
}
],
"related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance",
"response": [
{
- "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 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 target memory in vm",
- "name": "memorytargetkbs",
- "type": "long"
- },
- {
- "description": "the write (io) of disk on the vm",
- "name": "diskiowrite",
- "type": "long"
- },
- {
- "description": "the name of the domain in which the virtual machine exists",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "true if high-availability is enabled, false otherwise",
- "name": "haenable",
- "type": "boolean"
- },
- {
- "description": "the virtual network for the service offering",
- "name": "forvirtualnetwork",
- "type": "boolean"
- },
- {
- "description": "the memory used by the vm",
- "name": "memorykbs",
- "type": "long"
- },
- {},
- {
- "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.",
- "name": "isdynamicallyscalable",
- "type": "boolean"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the pool type of the virtual machine",
- "name": "pooltype",
+ "description": "the name of the disk offering of the virtual machine",
+ "name": "diskofferingname",
"type": "string"
},
{
@@ -14725,9 +14664,44 @@
"type": "resourceiconresponse"
},
{
- "description": "the memory allocated for the virtual machine",
- "name": "memory",
- "type": "integer"
+ "description": "the read (io) of disk on the vm",
+ "name": "diskioread",
+ "type": "long"
+ },
+ {
+ "description": "the total number of network traffic bytes sent",
+ "name": "sentbytes",
+ "type": "long"
+ },
+ {
+ "description": "the ID of the backup offering of the virtual machine",
+ "name": "backupofferingid",
+ "type": "string"
+ },
+ {
+ "description": "the user's name who deployed the virtual machine",
+ "name": "username",
+ "type": "string"
+ },
+ {
+ "description": "the target memory in vm",
+ "name": "memorytargetkbs",
+ "type": "long"
+ },
+ {
+ "description": "the group ID of the virtual machine",
+ "name": "groupid",
+ "type": "string"
+ },
+ {
+ "description": "the date when this virtual machine was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
},
{
"description": "the user's ID who deployed the virtual machine",
@@ -14735,8 +14709,23 @@
"type": "string"
},
{
- "description": "the state of the virtual machine",
- "name": "state",
+ "description": "the virtual network for the service offering",
+ "name": "forvirtualnetwork",
+ "type": "boolean"
+ },
+ {
+ "description": "List of read-only Vm details as comma separated string.",
+ "name": "readonlydetails",
+ "type": "string"
+ },
+ {
+ "description": "an optional field whether to the display the vm to the end user or not.",
+ "name": "displayvm",
+ "type": "boolean"
+ },
+ {
+ "description": "ssh key-pair",
+ "name": "keypair",
"type": "string"
},
{
@@ -14745,83 +14734,24 @@
"type": "string"
},
{
- "description": "the speed of each cpu",
- "name": "cpuspeed",
- "type": "integer"
- },
- {
- "description": "device type of the root volume",
- "name": "rootdevicetype",
- "type": "string"
- },
- {
"description": "the account associated with the virtual machine",
"name": "account",
"type": "string"
},
{
- "description": "instance name of the user vm; this parameter is returned to the ROOT admin only",
- "name": "instancename",
- "type": "string"
+ "description": "the speed of each cpu",
+ "name": "cpuspeed",
+ "type": "integer"
+ },
+ {},
+ {
+ "description": "Vm details in key/value pairs.",
+ "name": "details",
+ "type": "map"
},
{
- "description": "OS type id of the vm",
- "name": "ostypeid",
- "type": "string"
- },
- {
- "description": "device ID of the root volume",
- "name": "rootdeviceid",
- "type": "long"
- },
- {
- "description": "the internal memory that's free in vm or zero if it can not be calculated",
- "name": "memoryintfreekbs",
- "type": "long"
- },
- {
- "description": "the vgpu type used by the virtual machine",
- "name": "vgpu",
- "type": "string"
- },
- {
- "description": "Guest vm Boot Mode",
- "name": "bootmode",
- "type": "string"
- },
- {
- "description": "Os type ID of the virtual machine",
- "name": "guestosid",
- "type": "string"
- },
- {
- "description": "the name of the ISO attached to the virtual machine",
- "name": "isoname",
- "type": "string"
- },
- {
- "description": "ssh key-pair",
- "name": "keypair",
- "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": "Guest vm Boot Type",
- "name": "boottype",
- "type": "string"
- },
- {
- "description": "State of the Service from LB rule",
- "name": "servicestate",
+ "description": "the password (if exists) of the virtual machine",
+ "name": "password",
"type": "string"
},
{
@@ -14830,18 +14760,227 @@
"type": "long"
},
{
- "description": "the hypervisor on which the template runs",
- "name": "hypervisor",
+ "description": "user generated name. The name of the virtual machine is returned if no displayname exists.",
+ "name": "displayname",
"type": "string"
},
{
- "description": "the ID of the availablility zone for the virtual machine",
- "name": "zoneid",
+ "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": "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",
+ "type": "string"
+ },
+ {
+ "description": "device ID of the root volume",
+ "name": "rootdeviceid",
+ "type": "long"
+ },
+ {
+ "description": "the list of nics associated with vm",
+ "name": "nic",
+ "response": [
+ {
+ "description": "the isolation uri of the nic",
+ "name": "isolationuri",
+ "type": "string"
+ },
+ {
+ "description": "the gateway of IPv6 network",
+ "name": "ip6gateway",
+ "type": "string"
+ },
+ {
+ "description": "true if nic is default, false otherwise",
+ "name": "macaddress",
+ "type": "string"
+ },
+ {
+ "description": "ID of the 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": "true if nic is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {
+ "description": "IP addresses associated with NIC found for unmanaged VM",
+ "name": "ipaddresses",
+ "type": "list"
+ },
+ {
+ "description": "the name of the corresponding network",
+ "name": "networkname",
+ "type": "string"
+ },
+ {
+ "description": "the isolated private VLAN if available",
+ "name": "isolatedpvlan",
+ "type": "integer"
+ },
+ {
+ "description": "the Secondary ipv4 addr of nic",
+ "name": "secondaryip",
+ "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 broadcast uri of the nic",
+ "name": "broadcasturi",
+ "type": "string"
+ },
+ {
+ "description": "Type of adapter if available",
+ "name": "adaptertype",
+ "type": "string"
+ },
+ {
+ "description": "Id of the NSX Logical Switch (if NSX based), null otherwise",
+ "name": "nsxlogicalswitch",
+ "type": "string"
+ },
+ {
+ "description": "the cidr of IPv6 network",
+ "name": "ip6cidr",
+ "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": "device id for the network when plugged into the virtual machine",
+ "name": "deviceid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the nic",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the gateway of the nic",
+ "name": "gateway",
+ "type": "string"
+ },
+ {
+ "description": "the type of the nic",
+ "name": "type",
+ "type": "string"
+ },
+ {
+ "description": "the IPv6 address of network",
+ "name": "ip6address",
+ "type": "string"
+ },
+ {
+ "description": "the ip address of the nic",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "the isolated private VLAN type if available",
+ "name": "isolatedpvlantype",
+ "type": "string"
+ },
+ {
+ "description": "the netmask of the nic",
+ "name": "netmask",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "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 account owning the affinity group",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "virtual machine IDs associated with this affinity group",
+ "name": "virtualmachineIds",
+ "type": "list"
+ },
+ {
+ "description": "the description of the affinity group",
+ "name": "description",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID of the affinity group",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the affinity group",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the project ID of the affinity group",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the affinity group",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the name of the affinity group",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the type of the affinity group",
+ "name": "type",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "instance name of the user vm; this parameter is returned to the ROOT admin only",
+ "name": "instancename",
"type": "string"
},
{
@@ -14850,65 +14989,8 @@
"type": "string"
},
{
- "description": "the list of resource tags associated",
- "name": "tags",
- "response": [
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "an alternate display text of the ISO attached to the virtual machine",
- "name": "isodisplaytext",
+ "description": "OS type id of the vm",
+ "name": "ostypeid",
"type": "string"
},
{
@@ -14917,78 +14999,23 @@
"type": "string"
},
{
- "description": "the total number of network traffic bytes sent",
- "name": "sentbytes",
- "type": "long"
- },
- {
- "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 number of cpu this virtual machine is running with",
- "name": "cpunumber",
- "type": "integer"
- },
- {
- "description": "public IP address id associated with vm via Static nat rule",
- "name": "publicip",
+ "description": "an alternate display text of the ISO attached to the virtual machine",
+ "name": "isodisplaytext",
"type": "string"
},
{
- "description": "the project id of the vm",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the read (bytes) of disk on the vm",
- "name": "diskkbsread",
- "type": "long"
- },
- {
- "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": " an alternate display text of the template for the virtual machine",
"name": "templatedisplaytext",
"type": "string"
},
{
- "description": "the outgoing network traffic on the host",
- "name": "networkkbswrite",
- "type": "long"
- },
- {
- "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 name of the disk offering of the virtual machine",
- "name": "diskofferingname",
- "type": "string"
- },
- {
- "description": "the name of the virtual machine",
- "name": "name",
- "type": "string"
- },
- {
- "description": "user generated name. The name of the virtual machine is returned if no displayname exists.",
- "name": "displayname",
+ "description": "the name of the availability zone for the virtual machine",
+ "name": "zonename",
"type": "string"
},
{
@@ -14997,310 +15024,67 @@
"type": "string"
},
{
+ "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",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the host for the virtual machine",
+ "name": "hostid",
+ "type": "string"
+ },
+ {
+ "description": "the pool type of the virtual machine",
+ "name": "pooltype",
+ "type": "string"
+ },
+ {
+ "description": "Os type ID of the virtual machine",
+ "name": "guestosid",
+ "type": "string"
+ },
+ {
+ "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.",
+ "name": "isdynamicallyscalable",
+ "type": "boolean"
+ },
+ {},
+ {
+ "description": "Guest vm Boot Type",
+ "name": "boottype",
+ "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": "device type of the root volume",
+ "name": "rootdevicetype",
+ "type": "string"
+ },
+ {
+ "description": "the name of the ISO attached to the virtual machine",
+ "name": "isoname",
+ "type": "string"
+ },
+ {
"description": "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",
- "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": "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": "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 domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the 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 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",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "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 CIDR notation for the base IP address of the security group rule",
- "name": "cidr",
- "type": "string"
- },
- {
- "description": "the protocol of the security group rule",
- "name": "protocol",
- "type": "string"
- },
- {
- "description": "the type of the ICMP message response",
- "name": "icmptype",
- "type": "integer"
- },
- {
- "description": "the 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 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 id of the security group rule",
- "name": "ruleid",
- "type": "string"
- },
- {
- "description": "the type of the ICMP message response",
- "name": "icmptype",
- "type": "integer"
- },
- {
- "description": "security group name",
- "name": "securitygroupname",
- "type": "string"
- },
- {
- "description": "the list of resource tags associated with the rule",
- "name": "tags",
- "response": [
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "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 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 code for the ICMP message response",
- "name": "icmpcode",
- "type": "integer"
- },
- {
- "description": "the starting IP of the security group rule",
- "name": "startport",
- "type": "integer"
- },
- {
- "description": "account owning the security group rule",
- "name": "account",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
"description": "the project id of the group",
"name": "projectid",
"type": "string"
@@ -15316,6 +15100,187 @@
"type": "string"
},
{
+ "description": "the ID of the security group",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the group",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the domain name of the security group",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the list of resource tags associated with the rule",
+ "name": "tags",
+ "response": [
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "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": "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"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ }
+ ],
+ "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",
+ "type": "integer"
+ },
+ {
+ "description": "security group name",
+ "name": "securitygroupname",
+ "type": "string"
+ },
+ {
+ "description": "the protocol of the security group rule",
+ "name": "protocol",
+ "type": "string"
+ },
+ {
+ "description": "the CIDR notation for the base IP address of the security group rule",
+ "name": "cidr",
+ "type": "string"
+ },
+ {
+ "description": "the list of resource tags associated with the rule",
+ "name": "tags",
+ "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": "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 ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ }
+ ],
+ "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 type of the ICMP message response",
+ "name": "icmptype",
+ "type": "integer"
+ },
+ {
+ "description": "the id of the security group rule",
+ "name": "ruleid",
+ "type": "string"
+ },
+ {
+ "description": "the code for the ICMP message response",
+ "name": "icmpcode",
+ "type": "integer"
+ }
+ ],
+ "type": "set"
+ },
+ {
"description": "the name of the security group",
"name": "name",
"type": "string"
@@ -15324,6 +15289,125 @@
"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 ending IP of the security group rule ",
+ "name": "endport",
+ "type": "integer"
+ },
+ {
+ "description": "the starting IP of the security group rule",
+ "name": "startport",
+ "type": "integer"
+ },
+ {
+ "description": "account owning the security group rule",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the id of the security group rule",
+ "name": "ruleid",
+ "type": "string"
+ },
+ {
+ "description": "the list of resource tags associated with the rule",
+ "name": "tags",
+ "response": [
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "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 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": "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 protocol of the security group rule",
+ "name": "protocol",
+ "type": "string"
+ },
+ {
+ "description": "security group name",
+ "name": "securitygroupname",
+ "type": "string"
+ },
+ {
+ "description": "the code for the ICMP message response",
+ "name": "icmpcode",
+ "type": "integer"
+ },
+ {
+ "description": "the 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"
}
],
"type": "set"
@@ -15333,36 +15417,146 @@
"name": "diskofferingid",
"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": "the group ID of the virtual machine",
- "name": "groupid",
+ "description": "the memory allocated for the virtual machine",
+ "name": "memory",
+ "type": "integer"
+ },
+ {
+ "description": "the project name of the vm",
+ "name": "project",
"type": "string"
},
{
+ "description": "the amount of the vm's CPU currently used",
+ "name": "cpuused",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain in which the virtual machine exists",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the service offering of the virtual machine",
+ "name": "serviceofferingid",
+ "type": "string"
+ },
+ {
+ "description": "Guest vm Boot Mode",
+ "name": "bootmode",
+ "type": "string"
+ },
+ {
+ "description": "the name of the virtual machine",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the availablility zone for the virtual machine",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the outgoing network traffic on the host",
+ "name": "networkkbswrite",
+ "type": "long"
+ },
+ {
+ "description": "the memory used by the vm",
+ "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 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": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "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"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the number of cpu this virtual machine is running with",
+ "name": "cpunumber",
+ "type": "integer"
+ },
+ {
"description": "the write (bytes) of disk on the vm",
"name": "diskkbswrite",
"type": "long"
},
{
- "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 read (bytes) of disk on the vm",
+ "name": "diskkbsread",
+ "type": "long"
},
{
- "description": "the password (if exists) of the virtual machine",
- "name": "password",
+ "description": "the internal memory 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"
},
{
@@ -15371,238 +15565,44 @@
"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": "the domain name of the affinity group",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the project ID of the affinity group",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the description of the affinity group",
- "name": "description",
- "type": "string"
- },
- {
- "description": "the project name of the affinity group",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the type of the affinity group",
- "name": "type",
- "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": "virtual machine IDs associated with this affinity group",
- "name": "virtualmachineIds",
- "type": "list"
- }
- ],
- "type": "set"
- },
- {
- "description": "the name of the availability zone for the virtual machine",
- "name": "zonename",
+ "description": "the project id of the vm",
+ "name": "projectid",
"type": "string"
},
{
- "description": "the user's name who deployed the virtual machine",
- "name": "username",
- "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": "true if the entity/resource has annotations",
- "name": "hasannotations",
+ "description": "true if the password rest feature is enabled, false otherwise",
+ "name": "passwordenabled",
"type": "boolean"
},
{
- "description": "the date when this virtual machine was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the 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",
+ "description": "State of the Service from LB rule",
+ "name": "servicestate",
"type": "string"
},
{
- "description": "the list of nics associated with vm",
- "name": "nic",
- "response": [
- {
- "description": "the Secondary ipv4 addr of nic",
- "name": "secondaryip",
- "type": "list"
- },
- {
- "description": "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": "Id of the vm to which the nic belongs",
- "name": "virtualmachineid",
- "type": "string"
- },
- {
- "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise",
- "name": "nsxlogicalswitchport",
- "type": "string"
- },
- {
- "description": "the ip address of the nic",
- "name": "ipaddress",
- "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 extra dhcp options on the nic",
- "name": "extradhcpoption",
- "type": "list"
- },
- {
- "description": "Type of adapter if available",
- "name": "adaptertype",
- "type": "string"
- },
- {
- "description": "the IPv6 address of network",
- "name": "ip6address",
- "type": "string"
- },
- {
- "description": "the gateway of the nic",
- "name": "gateway",
- "type": "string"
- },
- {
- "description": "the isolation uri of the nic",
- "name": "isolationuri",
- "type": "string"
- },
- {
- "description": "the traffic type of the nic",
- "name": "traffictype",
- "type": "string"
- },
- {
- "description": "the netmask of the nic",
- "name": "netmask",
- "type": "string"
- },
- {
- "description": "ID of the VLAN/VNI if available",
- "name": "vlanid",
- "type": "integer"
- },
- {
- "description": "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 isolated private VLAN if available",
- "name": "isolatedpvlan",
- "type": "integer"
- },
- {
- "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": "device id for the network when plugged into the virtual machine",
- "name": "deviceid",
- "type": "string"
- },
- {
- "description": "the ID of the nic",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the name of the corresponding network",
- "name": "networkname",
- "type": "string"
- },
- {
- "description": "the ID of the corresponding network",
- "name": "networkid",
- "type": "string"
- }
- ],
- "type": "set"
+ "description": "the name of the service offering of the virtual machine",
+ "name": "serviceofferingname",
+ "type": "string"
+ },
+ {
+ "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": "the write (io) of disk on the vm",
+ "name": "diskiowrite",
+ "type": "long"
+ },
+ {
+ "description": "the date when this virtual machine was updated last time",
+ "name": "lastupdated",
+ "type": "date"
}
]
},
@@ -15612,13 +15612,6 @@
"name": "listGuestOsMapping",
"params": [
{
- "description": "list Guest OS mapping by hypervisor version. Must be used with hypervisor parameter",
- "length": 255,
- "name": "hypervisorversion",
- "required": false,
- "type": "string"
- },
- {
"description": "List by keyword",
"length": 255,
"name": "keyword",
@@ -15626,11 +15619,18 @@
"type": "string"
},
{
- "description": "",
+ "description": "list Guest OS mapping by hypervisor version. Must be used with hypervisor parameter",
"length": 255,
- "name": "pagesize",
+ "name": "hypervisorversion",
"required": false,
- "type": "integer"
+ "type": "string"
+ },
+ {
+ "description": "list Guest OS mapping by hypervisor",
+ "length": 255,
+ "name": "hypervisor",
+ "required": false,
+ "type": "string"
},
{
"description": "list mapping by its UUID",
@@ -15641,16 +15641,9 @@
"type": "uuid"
},
{
- "description": "list Guest OS mapping by hypervisor",
- "length": 255,
- "name": "hypervisor",
- "required": false,
- "type": "string"
- },
- {
"description": "",
"length": 255,
- "name": "page",
+ "name": "pagesize",
"required": false,
"type": "integer"
},
@@ -15661,40 +15654,27 @@
"related": "listOsTypes,addGuestOs",
"required": false,
"type": "uuid"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
}
],
"related": "addGuestOsMapping,updateGuestOsMapping",
"response": [
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
{},
{},
{
- "description": "standard display name for the Guest OS",
- "name": "osdisplayname",
- "type": "string"
- },
- {
"description": "the hypervisor",
"name": "hypervisor",
"type": "string"
},
{
- "description": "is the mapping user defined",
- "name": "isuserdefined",
- "type": "string"
- },
- {
- "description": "the ID of the Guest OS mapping",
- "name": "id",
- "type": "string"
- },
- {
- "description": "hypervisor specific name for the Guest OS",
- "name": "osnameforhypervisor",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
@@ -15703,13 +15683,33 @@
"type": "string"
},
{
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "hypervisor specific name for the Guest OS",
+ "name": "osnameforhypervisor",
+ "type": "string"
+ },
+ {
+ "description": "standard display name for the Guest OS",
+ "name": "osdisplayname",
+ "type": "string"
+ },
+ {
"description": "version of the hypervisor for mapping",
"name": "hypervisorversion",
"type": "string"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the ID of the Guest OS mapping",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "is the mapping user defined",
+ "name": "isuserdefined",
"type": "string"
}
],
@@ -15721,49 +15721,11 @@
"name": "listTemplates",
"params": [
{
- "description": "If set to true, list only unique templates across zones",
+ "description": "the template name",
"length": 255,
- "name": "showunique",
+ "name": "name",
"required": false,
- "since": "4.13.2",
- "type": "boolean"
- },
- {
- "description": "list templates by zoneId",
- "length": 255,
- "name": "zoneid",
- "related": "createZone,updateZone,listZones,listZones",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "list objects by project",
- "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": "",
- "length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
- },
- {
- "description": "show removed templates as well",
- "length": 255,
- "name": "showremoved",
- "required": false,
- "type": "boolean"
+ "type": "string"
},
{
"description": "list datadisk templates by parent template id",
@@ -15782,20 +15744,6 @@
"type": "string"
},
{
- "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false",
- "length": 255,
- "name": "listall",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "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 IDs of the templates, mutually exclusive with id",
"length": 255,
"name": "ids",
@@ -15805,6 +15753,14 @@
"type": "list"
},
{
+ "description": "list objects by project",
+ "length": 255,
+ "name": "projectid",
+ "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject",
+ "required": false,
+ "type": "uuid"
+ },
+ {
"description": "list only resources belonging to the domain specified",
"length": 255,
"name": "domainid",
@@ -15813,27 +15769,6 @@
"type": "uuid"
},
{
- "description": "flag to display the resource image for the templates",
- "length": 255,
- "name": "showicon",
- "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": "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": "List resources by tags (key/value pairs)",
"length": 255,
"name": "tags",
@@ -15848,11 +15783,40 @@
"type": "string"
},
{
- "description": "the template name",
+ "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false",
"length": 255,
- "name": "name",
+ "name": "listall",
"required": false,
- "type": "string"
+ "type": "boolean"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "list templates by zoneId",
+ "length": 255,
+ "name": "zoneid",
+ "related": "createZone,updateZone,listZones,listZones",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "show removed templates as well",
+ "length": 255,
+ "name": "showremoved",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "flag to display the resource image for the templates",
+ "length": 255,
+ "name": "showicon",
+ "required": false,
+ "type": "boolean"
},
{
"description": "the template ID",
@@ -15863,207 +15827,97 @@
"type": "uuid"
},
{
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ },
+ {
"description": "comma separated list of template details requested, value can be a list of [ all, min]",
"length": 255,
"name": "details",
"required": false,
"since": "4.15",
"type": "list"
+ },
+ {
+ "description": "If set to true, list only unique templates across zones",
+ "length": 255,
+ "name": "showunique",
+ "required": false,
+ "since": "4.13.2",
+ "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).",
+ "length": 255,
+ "name": "templatefilter",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
+ "length": 255,
+ "name": "isrecursive",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "list resources by account. Must be used with the domainId parameter.",
+ "length": 255,
+ "name": "account",
+ "required": false,
+ "type": "string"
}
],
"related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos",
"response": [
{
- "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 name of the domain to which the template belongs",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "true if the reset password feature is enabled, false otherwise",
- "name": "passwordenabled",
- "type": "boolean"
- },
- {},
- {
- "description": "the status of the template",
- "name": "status",
- "type": "string"
- },
- {
- "description": "the ID of the zone for this template",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the date this template was removed",
- "name": "removed",
- "type": "date"
- },
- {
- "description": "the template 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 secondary storage host for the template",
- "name": "hostid",
- "type": "string"
- },
- {
- "description": "true if template is sshkey enabled, false otherwise",
- "name": "sshkeyenabled",
- "type": "boolean"
- },
- {
- "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.",
- "name": "deployasis",
- "type": "boolean"
- },
- {
- "description": "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": "the name of the secondary storage host for the template",
- "name": "hostname",
- "type": "string"
- },
- {
- "description": "Lists the download progress of a template across all secondary storages",
- "name": "downloaddetails",
- "type": "list"
- },
- {
- "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage",
- "name": "directdownload",
- "type": "boolean"
- },
- {
- "description": "checksum of the template",
- "name": "checksum",
- "type": "string"
- },
- {
- "description": "the project name of the template",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the account id to which the template belongs",
- "name": "accountid",
- "type": "string"
- },
- {
"description": "if root disk template, then ids of the datas disk templates this template owns",
"name": "childtemplates",
"type": "set"
},
{
- "description": "if Datadisk template, then id of the root disk template this template belongs to",
- "name": "parenttemplateid",
- "type": "string"
- },
- {
- "description": "the format of the template.",
- "name": "format",
- "type": "imageformat"
- },
- {
- "description": "the processor bit size",
- "name": "bits",
- "type": "int"
- },
- {
- "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": "the URL which the template/iso is registered from",
- "name": "url",
- "type": "string"
- },
- {
"description": "the type of the template",
"name": "templatetype",
"type": "string"
},
{
- "description": "the tag of this template",
- "name": "templatetag",
- "type": "string"
- },
- {
- "description": "the size of the template",
- "name": "size",
- "type": "long"
- },
- {
"description": "the list of resource tags associated",
"name": "tags",
"response": [
{
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "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 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 project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
"description": "the project name where tag belongs to",
"name": "project",
"type": "string"
},
{
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
"description": "resource type",
"name": "resourcetype",
"type": "string"
@@ -16074,42 +15928,87 @@
"type": "string"
},
{
- "description": "customer associated with the tag",
- "name": "customer",
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
"type": "string"
}
],
"type": "set"
},
{
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "true if this template is a public template, false otherwise",
- "name": "ispublic",
- "type": "boolean"
- },
- {
- "description": "the hypervisor on which the template runs",
- "name": "hypervisor",
+ "description": "the ID of the domain to which the template belongs",
+ "name": "domainid",
"type": "string"
},
{
- "description": "the account name to which the template belongs",
- "name": "account",
+ "description": "the ID of the secondary storage host for the template",
+ "name": "hostid",
"type": "string"
},
{
+ "description": "the template ID",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "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": "the project name of the template",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "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",
+ "type": "string"
+ },
+ {
+ "description": "the template name",
+ "name": "name",
+ "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": "Base64 string representation of the resource icon",
"name": "icon",
"type": "resourceiconresponse"
},
{
- "description": "true if the template is ready to be deployed from, false otherwise.",
- "name": "isready",
- "type": "boolean"
+ "description": "the ID of the zone for this template",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the account id to which the template belongs",
+ "name": "accountid",
+ "type": "string"
},
{
"description": "the project id of the template",
@@ -16117,65 +16016,166 @@
"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 template display text",
- "name": "displaytext",
- "type": "string"
- },
- {
"description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory",
"name": "isdynamicallyscalable",
"type": "boolean"
},
{
- "description": "the name of the zone for this template",
- "name": "zonename",
+ "description": "the template display text",
+ "name": "displaytext",
"type": "string"
},
{
- "description": "true if the ISO is bootable, false otherwise",
- "name": "bootable",
+ "description": "the date this template was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
"type": "boolean"
},
{
- "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": "the ID of the domain to which the template belongs",
- "name": "domainid",
- "type": "string"
- },
- {},
- {
- "description": "the template name",
- "name": "name",
- "type": "string"
- },
- {
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
{
- "description": "true if this template is a featured template, false otherwise",
- "name": "isfeatured",
+ "description": "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": "true if the template is extractable, false otherwise",
- "name": "isextractable",
+ "description": "Lists the download progress of a template across all secondary storages",
+ "name": "downloaddetails",
+ "type": "list"
+ },
+ {
+ "description": "the hypervisor on which the template runs",
+ "name": "hypervisor",
+ "type": "string"
+ },
+ {
+ "description": "true if template requires HVM enabled, false otherwise",
+ "name": "requireshvm",
"type": "boolean"
+ },
+ {
+ "description": "the name of the domain to which the template belongs",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the URL which the template/iso is registered from",
+ "name": "url",
+ "type": "string"
+ },
+ {
+ "description": "the tag of this template",
+ "name": "templatetag",
+ "type": "string"
+ },
+ {
+ "description": "true if the template is ready to be deployed from, false otherwise.",
+ "name": "isready",
+ "type": "boolean"
+ },
+ {
+ "description": "the status of the template",
+ "name": "status",
+ "type": "string"
+ },
+ {
+ "description": "true if this template is a public template, false otherwise",
+ "name": "ispublic",
+ "type": "boolean"
+ },
+ {
+ "description": "the processor bit size",
+ "name": "bits",
+ "type": "int"
+ },
+ {
+ "description": "additional key/value details tied with template",
+ "name": "details",
+ "type": "map"
+ },
+ {},
+ {
+ "description": "VMware only: additional key/value details tied with deploy-as-is template",
+ "name": "deployasisdetails",
+ "type": "map"
+ },
+ {
+ "description": "the name of the secondary storage host for the template",
+ "name": "hostname",
+ "type": "string"
+ },
+ {
+ "description": "the date this template was removed",
+ "name": "removed",
+ "type": "date"
+ },
+ {
+ "description": "checksum of the template",
+ "name": "checksum",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the OS type for this template.",
+ "name": "ostypeid",
+ "type": "string"
+ },
+ {
+ "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.",
+ "name": "deployasis",
+ "type": "boolean"
+ },
+ {
+ "description": "true if template is sshkey enabled, false otherwise",
+ "name": "sshkeyenabled",
+ "type": "boolean"
+ },
+ {
+ "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": "the format of the template.",
+ "name": "format",
+ "type": "imageformat"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "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"
}
]
},
@@ -16185,13 +16185,6 @@
"name": "createAutoScalePolicy",
"params": [
{
- "description": "the action to be executed if all the conditions evaluate to true for the specified duration.",
- "length": 255,
- "name": "action",
- "required": true,
- "type": "string"
- },
- {
"description": "the cool down period for which the policy should not be evaluated after the action has been taken",
"length": 255,
"name": "quiettime",
@@ -16199,11 +16192,11 @@
"type": "integer"
},
{
- "description": "the duration for which the conditions have to be true before action is taken",
+ "description": "the action to be executed if all the conditions evaluate to true for the specified duration.",
"length": 255,
- "name": "duration",
+ "name": "action",
"required": true,
- "type": "integer"
+ "type": "string"
},
{
"description": "the list of IDs of the conditions that are being evaluated on every interval",
@@ -16212,6 +16205,13 @@
"related": "createCondition,listConditions",
"required": true,
"type": "list"
+ },
+ {
+ "description": "the duration for which the conditions have to be true before action is taken",
+ "length": 255,
+ "name": "duration",
+ "required": true,
+ "type": "integer"
}
],
"related": "listAutoScalePolicies,updateAutoScalePolicy",
@@ -16222,8 +16222,39 @@
"type": "integer"
},
{
- "description": "the autoscale policy ID",
- "name": "id",
+ "description": "the domain name of the autoscale policy",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the action to be executed if all the conditions evaluate to true for the specified duration.",
+ "name": "action",
+ "type": "string"
+ },
+ {
+ "description": "the project id autoscale policy",
+ "name": "projectid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the list of IDs of the conditions that are being evaluated on every interval",
+ "name": "conditions",
+ "type": "list"
+ },
+ {
+ "description": "the domain ID of the autoscale policy",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the autoscale policy",
+ "name": "project",
"type": "string"
},
{
@@ -16236,48 +16267,17 @@
"name": "jobid",
"type": "string"
},
- {
- "description": "the project id autoscale policy",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the action to be executed if all the conditions evaluate to true for the specified duration.",
- "name": "action",
- "type": "string"
- },
- {
- "description": "the domain ID of the autoscale policy",
- "name": "domainid",
- "type": "string"
- },
{},
{
- "description": "the list of IDs of the conditions that are being evaluated on every interval",
- "name": "conditions",
- "type": "list"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the project name of the autoscale policy",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the domain name of the autoscale policy",
- "name": "domain",
+ "description": "the autoscale policy ID",
+ "name": "id",
"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"
- },
- {}
+ }
]
},
{
@@ -16296,16 +16296,15 @@
],
"response": [
{
- "description": "true if operation is executed successfully",
- "name": "success",
- "type": "boolean"
- },
- {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
- {},
+ {
+ "description": "true if operation is executed successfully",
+ "name": "success",
+ "type": "boolean"
+ },
{},
{
"description": "any text associated with the success or failure",
@@ -16316,7 +16315,8 @@
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
- }
+ },
+ {}
]
},
{
@@ -16325,6 +16325,13 @@
"name": "listPhysicalNetworks",
"params": [
{
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "list physical network by id",
"length": 255,
"name": "id",
@@ -16333,23 +16340,9 @@
"type": "uuid"
},
{
- "description": "search by name",
- "length": 255,
- "name": "name",
- "required": false,
- "type": "string"
- },
- {
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
- },
- {
"description": "",
"length": 255,
- "name": "page",
+ "name": "pagesize",
"required": false,
"type": "integer"
},
@@ -16364,36 +16357,23 @@
{
"description": "",
"length": 255,
- "name": "pagesize",
+ "name": "page",
"required": false,
"type": "integer"
+ },
+ {
+ "description": "search by name",
+ "length": 255,
+ "name": "name",
+ "required": false,
+ "type": "string"
}
],
"related": "createPhysicalNetwork,updatePhysicalNetwork",
"response": [
{
- "description": "the speed of the physical network",
- "name": "networkspeed",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "state of the physical network",
- "name": "state",
- "type": "string"
- },
- {
- "description": "comma separated tag",
- "name": "tags",
- "type": "string"
- },
- {
- "description": "Broadcast domain range of the physical network",
- "name": "broadcastdomainrange",
+ "description": "isolation methods",
+ "name": "isolationmethods",
"type": "string"
},
{
@@ -16402,13 +16382,8 @@
"type": "string"
},
{
- "description": "name of the physical network",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the domain id of the physical network owner",
- "name": "domainid",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
@@ -16417,26 +16392,51 @@
"type": "integer"
},
{
+ "description": "state of the physical network",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "Broadcast domain range of the physical network",
+ "name": "broadcastdomainrange",
+ "type": "string"
+ },
+ {
+ "description": "the vlan of the physical network",
+ "name": "vlan",
+ "type": "string"
+ },
+ {
"description": "the uuid of the physical network",
"name": "id",
"type": "string"
},
{},
{
- "description": "the vlan of the physical network",
- "name": "vlan",
+ "description": "comma separated tag",
+ "name": "tags",
"type": "string"
},
- {},
{
- "description": "isolation methods",
- "name": "isolationmethods",
+ "description": "the speed of the physical network",
+ "name": "networkspeed",
"type": "string"
},
{
"description": "zone name of the physical network",
"name": "zonename",
"type": "string"
+ },
+ {
+ "description": "name of the physical network",
+ "name": "name",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the domain id of the physical network owner",
+ "name": "domainid",
+ "type": "string"
}
],
"since": "3.0.0"
@@ -16456,17 +16456,7 @@
}
],
"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",
@@ -16477,6 +16467,16 @@
"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.11"
@@ -16487,22 +16487,6 @@
"name": "listFirewallRules",
"params": [
{
- "description": "List resources by tags (key/value pairs)",
- "length": 255,
- "name": "tags",
- "required": false,
- "type": "map"
- },
- {
- "description": "list firewall rules for certain network",
- "length": 255,
- "name": "networkid",
- "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks",
- "required": false,
- "since": "4.3",
- "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",
@@ -16510,6 +16494,43 @@
"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",
+ "length": 255,
+ "name": "domainid",
+ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "the ID of IP address of the firewall services",
+ "length": 255,
+ "name": "ipaddressid",
+ "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false",
+ "length": 255,
+ "name": "listall",
+ "required": false,
+ "type": "boolean"
+ },
+ {
"description": "list objects by project",
"length": 255,
"name": "projectid",
@@ -16518,23 +16539,24 @@
"type": "uuid"
},
{
- "description": "",
+ "description": "List resources by tags (key/value pairs)",
"length": 255,
- "name": "page",
+ "name": "tags",
"required": false,
- "type": "integer"
+ "type": "map"
},
{
- "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false",
+ "description": "Lists rule with the specified ID.",
"length": 255,
- "name": "listall",
+ "name": "id",
+ "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules",
"required": false,
- "type": "boolean"
+ "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"
},
@@ -16547,42 +16569,20 @@
"type": "boolean"
},
{
- "description": "the ID of IP address of the firewall services",
- "length": 255,
- "name": "ipaddressid",
- "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "list only resources belonging to the domain specified",
- "length": 255,
- "name": "domainid",
- "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
- },
- {
- "description": "Lists rule with the specified ID.",
- "length": 255,
- "name": "id",
- "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules",
- "required": false,
- "type": "uuid"
- },
- {
"description": "",
"length": 255,
- "name": "pagesize",
+ "name": "page",
"required": false,
"type": "integer"
+ },
+ {
+ "description": "list firewall rules for certain network",
+ "length": 255,
+ "name": "networkid",
+ "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks",
+ "required": false,
+ "since": "4.3",
+ "type": "uuid"
}
],
"related": "createFirewallRule,updateEgressFirewallRule",
@@ -16593,13 +16593,24 @@
"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 ID of the firewall rule",
- "name": "id",
+ "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 cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).",
+ "name": "destcidrlist",
"type": "string"
},
{
@@ -16608,29 +16619,18 @@
"type": "string"
},
{
- "description": "the public ip address id for the firewall rule",
- "name": "ipaddressid",
- "type": "string"
- },
- {},
- {
- "description": "the protocol of the firewall rule",
- "name": "protocol",
- "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 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 state of the rule",
- "name": "state",
+ "description": "type of the icmp message being sent",
+ "name": "icmptype",
+ "type": "integer"
+ },
+ {
+ "description": "the public ip address id for the firewall rule",
+ "name": "ipaddressid",
"type": "string"
},
{
@@ -16638,11 +16638,6 @@
"name": "tags",
"response": [
{
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
"description": "the project name where tag belongs to",
"name": "project",
"type": "string"
@@ -16653,13 +16648,13 @@
"type": "string"
},
{
- "description": "tag key name",
- "name": "key",
+ "description": "customer associated with the tag",
+ "name": "customer",
"type": "string"
},
{
- "description": "customer associated with the tag",
- "name": "customer",
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
"type": "string"
},
{
@@ -16673,6 +16668,11 @@
"type": "string"
},
{
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
"description": "the account associated with the tag",
"name": "account",
"type": "string"
@@ -16683,42 +16683,42 @@
"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 starting port of firewall rule's port range",
+ "name": "startport",
+ "type": "integer"
+ },
{
"description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).",
"name": "cidrlist",
"type": "string"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "is rule for display to the regular user",
- "name": "fordisplay",
- "type": "boolean"
- },
- {
"description": "the ending port of firewall rule's port range",
"name": "endport",
"type": "integer"
},
{
- "description": "error code for this icmp message",
- "name": "icmpcode",
- "type": "integer"
+ "description": "the state of the rule",
+ "name": "state",
+ "type": "string"
},
- {},
{
- "description": "the starting port of firewall rule's port range",
- "name": "startport",
+ "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"
}
]
@@ -16740,7 +16740,6 @@
"type": "integer"
},
{},
- {},
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
@@ -16750,7 +16749,8 @@
"description": "true if operation is executed successfully",
"name": "success",
"type": "boolean"
- }
+ },
+ {}
]
},
{
@@ -16769,16 +16769,15 @@
],
"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",
@@ -16786,10 +16785,11 @@
},
{},
{
- "description": "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"
+ },
+ {}
]
},
{
@@ -16798,6 +16798,13 @@
"name": "extractIso",
"params": [
{
+ "description": "the URL to which the ISO would be extracted",
+ "length": 2048,
+ "name": "url",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "the ID of the zone where the ISO is originally located",
"length": 255,
"name": "zoneid",
@@ -16806,10 +16813,10 @@
"type": "uuid"
},
{
- "description": "the URL to which the ISO would be extracted",
- "length": 2048,
- "name": "url",
- "required": false,
+ "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD",
+ "length": 255,
+ "name": "mode",
+ "required": true,
"type": "string"
},
{
@@ -16819,87 +16826,43 @@
"related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos",
"required": true,
"type": "uuid"
- },
- {
- "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD",
- "length": 255,
- "name": "mode",
- "required": true,
- "type": "string"
}
],
"related": "extractTemplate,extractVolume",
"response": [
{
- "description": "the percentage of the entity uploaded to the specified location",
- "name": "uploadpercentage",
- "type": "integer"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "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 account id to which the extracted object belongs",
"name": "accountid",
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {},
- {},
- {
- "description": "type of the storage",
- "name": "storagetype",
- "type": "string"
- },
- {
- "description": "the mode of extraction - upload or download",
- "name": "extractMode",
- "type": "string"
- },
- {
- "description": "zone ID the object was extracted from",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "",
- "name": "resultstring",
- "type": "string"
- },
- {
"description": "the id of extracted object",
"name": "id",
"type": "string"
},
{
- "description": "the state of the extracted object",
- "name": "state",
+ "description": "the time and date the object was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
- "description": "zone name the object was extracted from",
- "name": "zonename",
+ "description": "",
+ "name": "resultstring",
"type": "string"
},
{
- "description": "the upload id of extracted object",
- "name": "extractId",
+ "description": "the name of the extracted object",
+ "name": "name",
"type": "string"
},
{
@@ -16908,8 +16871,45 @@
"type": "string"
},
{
- "description": "the name of the extracted object",
- "name": "name",
+ "description": "zone ID the object was extracted from",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the state of the extracted object",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "the mode of extraction - upload or download",
+ "name": "extractMode",
+ "type": "string"
+ },
+ {
+ "description": "zone name the object was extracted from",
+ "name": "zonename",
+ "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": "the upload id of extracted object",
+ "name": "extractId",
+ "type": "string"
+ },
+ {
+ "description": "type of the storage",
+ "name": "storagetype",
"type": "string"
}
]
@@ -16920,11 +16920,12 @@
"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": "string"
+ "type": "uuid"
},
{
"description": "the staging store provider name",
@@ -16948,17 +16949,36 @@
"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"
}
],
"related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore",
"response": [
{
+ "description": "the Zone ID of the image store",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the image store",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the host's currently used disk size",
+ "name": "disksizeused",
+ "type": "long"
+ },
+ {
+ "description": "the provider name of the image store",
+ "name": "providername",
+ "type": "string"
+ },
+ {
"description": "the url of the image store",
"name": "url",
"type": "string"
@@ -16969,65 +16989,45 @@
"type": "boolean"
},
{
- "description": "the Zone ID of the image store",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the ID of the image store",
- "name": "id",
- "type": "string"
- },
- {
- "description": "defines if store is read-only",
- "name": "readonly",
- "type": "boolean"
- },
- {},
- {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
{
- "description": "the Zone name of the image store",
- "name": "zonename",
- "type": "string"
- },
- {},
- {
- "description": "the protocol of the image store",
- "name": "protocol",
- "type": "string"
- },
- {
- "description": "the provider name of the image store",
- "name": "providername",
- "type": "string"
- },
- {
- "description": "the host's currently used disk size",
- "name": "disksizeused",
- "type": "long"
- },
- {
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
{
- "description": "the total disk size of the host",
- "name": "disksizetotal",
- "type": "long"
+ "description": "the Zone name of the image store",
+ "name": "zonename",
+ "type": "string"
},
{
"description": "the scope of the image store",
"name": "scope",
"type": "scopetype"
},
+ {},
{
- "description": "the name of the image store",
- "name": "name",
+ "description": "defines if store is read-only",
+ "name": "readonly",
+ "type": "boolean"
+ },
+ {
+ "description": "the total disk size of the host",
+ "name": "disksizetotal",
+ "type": "long"
+ },
+ {},
+ {
+ "description": "the ID of the image store",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the protocol of the image store",
+ "name": "protocol",
"type": "string"
}
]
@@ -17038,6 +17038,20 @@
"name": "createAffinityGroup",
"params": [
{
+ "description": "Type of the affinity group from the available affinity/anti-affinity group types",
+ "length": 255,
+ "name": "type",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "name of the affinity group",
+ "length": 255,
+ "name": "name",
+ "required": true,
+ "type": "string"
+ },
+ {
"description": "create affinity group for project",
"length": 255,
"name": "projectid",
@@ -17046,14 +17060,6 @@
"type": "uuid"
},
{
- "description": "domainId of the account owning the affinity group",
- "length": 255,
- "name": "domainid",
- "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
- "required": false,
- "type": "uuid"
- },
- {
"description": "optional description of the affinity group",
"length": 255,
"name": "description",
@@ -17061,91 +17067,85 @@
"type": "string"
},
{
+ "description": "domainId of the account owning the affinity group",
+ "length": 255,
+ "name": "domainid",
+ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
+ "required": false,
+ "type": "uuid"
+ },
+ {
"description": "an account for the affinity group. Must be used with domainId.",
"length": 255,
"name": "account",
"required": false,
"type": "string"
- },
- {
- "description": "name of the affinity group",
- "length": 255,
- "name": "name",
- "required": true,
- "type": "string"
- },
- {
- "description": "Type of the affinity group from the available affinity/anti-affinity group types",
- "length": 255,
- "name": "type",
- "required": true,
- "type": "string"
}
],
"related": "",
"response": [
{
+ "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 type of the affinity group",
+ "name": "type",
+ "type": "string"
+ },
+ {
+ "description": "the description of the affinity group",
+ "name": "description",
+ "type": "string"
+ },
+ {
+ "description": "the name of the affinity group",
+ "name": "name",
+ "type": "string"
+ },
+ {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
{
- "description": "the project name of the affinity group",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the ID of the affinity group",
- "name": "id",
- "type": "string"
- },
- {},
- {
- "description": "the account owning the affinity group",
- "name": "account",
- "type": "string"
- },
- {
"description": "the project ID of the affinity group",
"name": "projectid",
"type": "string"
},
{
- "description": "the domain ID of the affinity group",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the type of the affinity group",
- "name": "type",
- "type": "string"
- },
- {
- "description": "the domain name of the affinity group",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the description of the affinity group",
- "name": "description",
- "type": "string"
- },
- {},
- {
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
{
- "description": "the name of the affinity group",
- "name": "name",
+ "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 account owning the affinity group",
+ "name": "account",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the domain name of the affinity group",
+ "name": "domain",
+ "type": "string"
+ },
+ {}
]
},
{
@@ -17165,25 +17165,25 @@
"response": [
{},
{
- "description": "true if operation is executed successfully",
- "name": "success",
- "type": "boolean"
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
},
{},
{
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
"description": "any text associated with the success or failure",
"name": "displaytext",
"type": "string"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "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"
}
]
},
@@ -17193,11 +17193,18 @@
"name": "listInternalLoadBalancerElements",
"params": [
{
- "description": "list internal load balancer elements by enabled state",
+ "description": "",
"length": 255,
- "name": "enabled",
+ "name": "pagesize",
"required": false,
- "type": "boolean"
+ "type": "integer"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
},
{
"description": "List by keyword",
@@ -17223,49 +17230,42 @@
"type": "uuid"
},
{
- "description": "",
+ "description": "list internal load balancer elements by enabled state",
"length": 255,
- "name": "page",
+ "name": "enabled",
"required": false,
- "type": "integer"
- },
- {
- "description": "",
- "length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
+ "type": "boolean"
}
],
"related": "configureInternalLoadBalancerElement,createInternalLoadBalancerElement",
"response": [
- {},
- {},
- {
- "description": "the id of the internal load balancer element",
- "name": "id",
- "type": "string"
- },
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
{
- "description": "the physical network service provider id of the element",
- "name": "nspid",
+ "description": "the id of the internal load balancer element",
+ "name": "id",
"type": "string"
},
{
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
"description": "Enabled/Disabled the element",
"name": "enabled",
"type": "boolean"
},
{
- "description": "the 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"
+ },
+ {},
+ {}
],
"since": "4.2.0"
},
@@ -17275,14 +17275,6 @@
"name": "updateLBHealthCheckPolicy",
"params": [
{
- "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only",
- "length": 255,
- "name": "customid",
- "required": false,
- "since": "4.4",
- "type": "string"
- },
- {
"description": "ID of load balancer health check policy",
"length": 255,
"name": "id",
@@ -17291,6 +17283,14 @@
"type": "uuid"
},
{
+ "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only",
+ "length": 255,
+ "name": "customid",
+ "required": false,
+ "since": "4.4",
+ "type": "string"
+ },
+ {
"description": "an optional field, whether to the display the policy to the end user or not",
"length": 255,
"name": "fordisplay",
@@ -17302,64 +17302,11 @@
"related": "createLBHealthCheckPolicy,listLBHealthCheckPolicies",
"response": [
{
- "description": "the list of healthcheckpolicies",
- "name": "healthcheckpolicy",
- "response": [
- {
- "description": "the LB HealthCheck policy ID",
- "name": "id",
- "type": "string"
- },
- {
- "description": "Number of consecutive health check failures before declaring an instance unhealthy.",
- "name": "unhealthcheckthresshold",
- "type": "int"
- },
- {
- "description": "is policy for display to the regular user",
- "name": "fordisplay",
- "type": "boolean"
- },
- {
- "description": "the pingpath of the healthcheck policy",
- "name": "pingpath",
- "type": "string"
- },
- {
- "description": "the description of the healthcheck policy",
- "name": "description",
- "type": "string"
- },
- {
- "description": "the state of the policy",
- "name": "state",
- "type": "string"
- },
- {
- "description": "Amount of time between health checks",
- "name": "healthcheckinterval",
- "type": "int"
- },
- {
- "description": "Time to wait when receiving a response from the health check",
- "name": "responsetime",
- "type": "int"
- },
- {
- "description": "Number of consecutive health check success before declaring an instance healthy",
- "name": "healthcheckthresshold",
- "type": "int"
- }
- ],
- "type": "list"
+ "description": "the LB rule ID",
+ "name": "lbruleid",
+ "type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {},
- {
"description": "the domain of the HealthCheck policy",
"name": "domain",
"type": "string"
@@ -17369,26 +17316,79 @@
"name": "domainid",
"type": "string"
},
+ {},
{
"description": "the account of the HealthCheck policy",
"name": "account",
"type": "string"
},
{
+ "description": "the list of healthcheckpolicies",
+ "name": "healthcheckpolicy",
+ "response": [
+ {
+ "description": "Number of consecutive health check success before declaring an instance healthy",
+ "name": "healthcheckthresshold",
+ "type": "int"
+ },
+ {
+ "description": "Number of consecutive health check failures before declaring an instance unhealthy.",
+ "name": "unhealthcheckthresshold",
+ "type": "int"
+ },
+ {
+ "description": "the description of the healthcheck policy",
+ "name": "description",
+ "type": "string"
+ },
+ {
+ "description": "Amount of time between health checks",
+ "name": "healthcheckinterval",
+ "type": "int"
+ },
+ {
+ "description": "the state of the policy",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "the pingpath of the healthcheck policy",
+ "name": "pingpath",
+ "type": "string"
+ },
+ {
+ "description": "the LB HealthCheck policy ID",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "Time to wait when receiving a response from the health check",
+ "name": "responsetime",
+ "type": "int"
+ },
+ {
+ "description": "is policy for display to the regular user",
+ "name": "fordisplay",
+ "type": "boolean"
+ }
+ ],
+ "type": "list"
+ },
+ {},
+ {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
{
- "description": "the LB rule ID",
- "name": "lbruleid",
- "type": "string"
- },
- {},
- {
"description": "the 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"
}
],
"since": "4.4"
@@ -17399,14 +17399,6 @@
"name": "rebootVirtualMachine",
"params": [
{
- "description": "Force reboot the VM (VM is Stopped and then Started)",
- "length": 255,
- "name": "forced",
- "required": false,
- "since": "4.16.0",
- "type": "boolean"
- },
- {
"description": "Boot into hardware setup menu or not",
"length": 255,
"name": "bootintosetup",
@@ -17415,6 +17407,14 @@
"type": "boolean"
},
{
+ "description": "Force reboot the VM (VM is Stopped and then Started)",
+ "length": 255,
+ "name": "forced",
+ "required": false,
+ "since": "4.16.0",
+ "type": "boolean"
+ },
+ {
"description": "The ID of the virtual machine",
"length": 255,
"name": "id",
@@ -17426,73 +17426,269 @@
"related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance",
"response": [
{
- "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 internal memory that's free in vm or zero if it can not be calculated",
- "name": "memoryintfreekbs",
+ "description": "the memory used by the vm",
+ "name": "memorykbs",
"type": "long"
},
- {},
+ {
+ "description": "Os type ID of the virtual machine",
+ "name": "guestosid",
+ "type": "string"
+ },
+ {
+ "description": "the pool type of the virtual machine",
+ "name": "pooltype",
+ "type": "string"
+ },
+ {
+ "description": "the name of the disk offering of the virtual machine",
+ "name": "diskofferingname",
+ "type": "string"
+ },
+ {
+ "description": "ssh key-pair",
+ "name": "keypair",
+ "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 amount of the vm's CPU currently used",
+ "name": "cpuused",
+ "type": "string"
+ },
+ {
"description": "the target memory in vm",
"name": "memorytargetkbs",
"type": "long"
},
{
- "description": "the project id of the vm",
- "name": "projectid",
+ "description": " an alternate display text of the template for the virtual machine",
+ "name": "templatedisplaytext",
"type": "string"
},
{
+ "description": "the 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": "the ID of the domain in which the virtual machine exists",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "an optional field whether to the display the vm to the end user or not.",
+ "name": "displayvm",
+ "type": "boolean"
+ },
+ {
+ "description": "the 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 name of the ISO attached to the virtual machine",
+ "name": "isoname",
+ "type": "string"
+ },
+ {
+ "description": "the speed of each cpu",
+ "name": "cpuspeed",
+ "type": "integer"
+ },
+ {
+ "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": "list of affinity groups associated with the virtual machine",
+ "name": "affinitygroup",
+ "response": [
+ {
+ "description": "the name of the affinity group",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "virtual machine IDs associated with this affinity group",
+ "name": "virtualmachineIds",
+ "type": "list"
+ },
+ {
+ "description": "the account owning the affinity group",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the project ID of the affinity group",
+ "name": "projectid",
+ "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 name of the affinity group",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the affinity group",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the description of the affinity group",
+ "name": "description",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID of the affinity group",
+ "name": "domainid",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the ID of the ISO attached to the virtual machine",
+ "name": "isoid",
+ "type": "string"
+ },
+ {
+ "description": "user generated name. The name of the virtual machine is returned if no displayname exists.",
+ "name": "displayname",
+ "type": "string"
+ },
+ {
+ "description": "the name of the host for the virtual machine",
+ "name": "hostname",
+ "type": "string"
+ },
+ {
+ "description": "the date when this virtual machine was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "device type of the root volume",
+ "name": "rootdevicetype",
+ "type": "string"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the incoming network traffic on the vm",
+ "name": "networkkbsread",
+ "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": "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 account associated with the virtual machine",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the state of the virtual machine",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "Guest vm Boot Type",
+ "name": "boottype",
+ "type": "string"
+ },
+ {
+ "description": "true if high-availability is enabled, false otherwise",
+ "name": "haenable",
+ "type": "boolean"
+ },
+ {
+ "description": "the read (bytes) of disk on the vm",
+ "name": "diskkbsread",
+ "type": "long"
+ },
+ {
"description": "the list of resource tags associated",
"name": "tags",
"response": [
{
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
"description": "id of the resource",
"name": "resourceid",
"type": "string"
},
{
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
"description": "the 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",
"type": "string"
},
{
@@ -17501,9 +17697,181 @@
"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",
+ "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"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the outgoing network traffic on the host",
+ "name": "networkkbswrite",
+ "type": "long"
+ },
+ {
+ "description": "the write (io) of disk on the vm",
+ "name": "diskiowrite",
+ "type": "long"
+ },
+ {
+ "description": "the group name of the virtual machine",
+ "name": "group",
+ "type": "string"
+ },
+ {
+ "description": "the list of nics associated with vm",
+ "name": "nic",
+ "response": [
+ {
+ "description": "the gateway of IPv6 network",
+ "name": "ip6gateway",
+ "type": "string"
+ },
+ {
+ "description": "the type of the nic",
+ "name": "type",
+ "type": "string"
+ },
+ {
+ "description": "the netmask of the nic",
+ "name": "netmask",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the corresponding network",
+ "name": "networkid",
+ "type": "string"
+ },
+ {
+ "description": "the extra dhcp options on the nic",
+ "name": "extradhcpoption",
+ "type": "list"
+ },
+ {
+ "description": "device id for the network when plugged into the virtual machine",
+ "name": "deviceid",
+ "type": "string"
+ },
+ {
+ "description": "the IPv6 address of network",
+ "name": "ip6address",
+ "type": "string"
+ },
+ {
+ "description": "the isolated private VLAN type if available",
+ "name": "isolatedpvlantype",
+ "type": "string"
+ },
+ {
+ "description": "the traffic type of the nic",
+ "name": "traffictype",
+ "type": "string"
+ },
+ {
+ "description": "the isolation uri of the nic",
+ "name": "isolationuri",
+ "type": "string"
+ },
+ {
+ "description": "the cidr of IPv6 network",
+ "name": "ip6cidr",
+ "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": "IP addresses associated with NIC found for unmanaged VM",
+ "name": "ipaddresses",
+ "type": "list"
+ },
+ {
+ "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise",
+ "name": "nsxlogicalswitchport",
+ "type": "string"
+ },
+ {
+ "description": "the ip address of the nic",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "true if nic is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {
+ "description": "Id of the vm to which the nic belongs",
+ "name": "virtualmachineid",
+ "type": "string"
+ },
+ {
+ "description": "the 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 broadcast uri of the nic",
+ "name": "broadcasturi",
+ "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 ID of the nic",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the gateway of the nic",
+ "name": "gateway",
+ "type": "string"
+ },
+ {
+ "description": "the Secondary ipv4 addr of nic",
+ "name": "secondaryip",
+ "type": "list"
}
],
"type": "set"
@@ -17523,243 +17891,15 @@
"type": "string"
},
{
- "description": "the domain name of the security group",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the list of egress rules associated with the security group",
- "name": "egressrule",
- "response": [
- {
- "description": "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": "account owning the security group rule",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the list of resource tags associated with the rule",
- "name": "tags",
- "response": [
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the CIDR notation for the base IP address of the security group rule",
- "name": "cidr",
- "type": "string"
- },
- {
- "description": "the ending IP of the security group rule ",
- "name": "endport",
- "type": "integer"
- },
- {
- "description": "the protocol of the security group rule",
- "name": "protocol",
- "type": "string"
- },
- {
- "description": "the code for the ICMP message response",
- "name": "icmpcode",
- "type": "integer"
- }
- ],
- "type": "set"
- },
- {
- "description": "the list of ingress rules associated with the security group",
- "name": "ingressrule",
- "response": [
- {
- "description": "the CIDR notation for the base IP address of the security group rule",
- "name": "cidr",
- "type": "string"
- },
- {
- "description": "the type of the ICMP message response",
- "name": "icmptype",
- "type": "integer"
- },
- {
- "description": "the ending IP of the security group rule ",
- "name": "endport",
- "type": "integer"
- },
- {
- "description": "the list of resource tags associated with the rule",
- "name": "tags",
- "response": [
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the protocol of the security group rule",
- "name": "protocol",
- "type": "string"
- },
- {
- "description": "security group name",
- "name": "securitygroupname",
- "type": "string"
- },
- {
- "description": "the starting IP of the security group rule",
- "name": "startport",
- "type": "integer"
- },
- {
- "description": "the 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"
- }
- ],
- "type": "set"
- },
- {
- "description": "the number of virtualmachines associated with this securitygroup",
- "name": "virtualmachinecount",
- "type": "integer"
- },
- {
- "description": "the name of the security group",
- "name": "name",
- "type": "string"
- },
- {
"description": "the list of resource tags associated with the rule",
"name": "tags",
"response": [
{
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
"description": "the domain associated with the tag",
"name": "domain",
"type": "string"
@@ -17770,16 +17910,6 @@
"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"
@@ -17790,23 +17920,28 @@
"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",
+ "description": "resource type",
+ "name": "resourcetype",
"type": "string"
},
{
- "description": "resource type",
- "name": "resourcetype",
+ "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"
}
],
@@ -17818,66 +17953,284 @@
"type": "string"
},
{
+ "description": "the list of egress rules associated with the security group",
+ "name": "egressrule",
+ "response": [
+ {
+ "description": "security group name",
+ "name": "securitygroupname",
+ "type": "string"
+ },
+ {
+ "description": "account owning the security group rule",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the id of the security group rule",
+ "name": "ruleid",
+ "type": "string"
+ },
+ {
+ "description": "the list of resource tags associated with the rule",
+ "name": "tags",
+ "response": [
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "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": "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 ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the protocol of the security group rule",
+ "name": "protocol",
+ "type": "string"
+ },
+ {
+ "description": "the CIDR notation for the base IP address of the security group rule",
+ "name": "cidr",
+ "type": "string"
+ },
+ {
+ "description": "the type of the ICMP message response",
+ "name": "icmptype",
+ "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 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 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 starting IP of the security group rule",
+ "name": "startport",
+ "type": "integer"
+ },
+ {
+ "description": "account owning the security group rule",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the list of resource tags associated with the rule",
+ "name": "tags",
+ "response": [
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "the 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": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the 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 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 domain name of the security group",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID of the security group",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
"description": "the project id of the group",
"name": "projectid",
"type": "string"
},
{
+ "description": "the name of the security group",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the number of virtualmachines associated with this securitygroup",
+ "name": "virtualmachinecount",
+ "type": "integer"
+ },
+ {
"description": "the list of virtualmachine ids associated with this securitygroup",
"name": "virtualmachineids",
"type": "set"
- },
- {
- "description": "the domain ID of the security group",
- "name": "domainid",
- "type": "string"
}
],
"type": "set"
},
{
- "description": "the group ID of the virtual machine",
- "name": "groupid",
+ "description": "the ID of the disk offering of the virtual machine",
+ "name": "diskofferingid",
"type": "string"
},
{
- "description": "Os type ID of the virtual machine",
- "name": "guestosid",
- "type": "string"
- },
- {
- "description": "true if high-availability is enabled, false otherwise",
- "name": "haenable",
+ "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",
- "name": "diskofferingname",
+ "description": "the number of cpu this virtual machine is running with",
+ "name": "cpunumber",
+ "type": "integer"
+ },
+ {
+ "description": "the name of the backup offering of the virtual machine",
+ "name": "backupofferingname",
"type": "string"
},
{
- "description": "the memory used by the vm",
- "name": "memorykbs",
- "type": "long"
- },
- {
- "description": "the password (if exists) of the virtual machine",
- "name": "password",
- "type": "string"
- },
- {
- "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 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"
},
{
@@ -17891,44 +18244,9 @@
"type": "string"
},
{
- "description": "the name of the backup offering of the virtual machine",
- "name": "backupofferingname",
- "type": "string"
- },
- {
- "description": "public IP address id associated with vm via Static nat rule",
- "name": "publicipid",
- "type": "string"
- },
- {
- "description": "the date when this virtual machine was updated last time",
- "name": "lastupdated",
- "type": "date"
- },
- {
- "description": "OS type id of the vm",
- "name": "ostypeid",
- "type": "string"
- },
- {
- "description": "the project name of the vm",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the number of cpu this virtual machine is running with",
- "name": "cpunumber",
- "type": "integer"
- },
- {
- "description": "List of read-only Vm details as comma separated string.",
- "name": "readonlydetails",
- "type": "string"
- },
- {
- "description": "ssh key-pair",
- "name": "keypair",
- "type": "string"
+ "description": "the write (bytes) of disk on the vm",
+ "name": "diskkbswrite",
+ "type": "long"
},
{
"description": "the ID of the virtual machine",
@@ -17936,274 +18254,8 @@
"type": "string"
},
{
- "description": "the ID of the disk offering of the virtual machine",
- "name": "diskofferingid",
- "type": "string"
- },
- {
- "description": "device ID of the root volume",
- "name": "rootdeviceid",
- "type": "long"
- },
- {
- "description": "list of affinity groups associated with the virtual machine",
- "name": "affinitygroup",
- "response": [
- {
- "description": "the ID of the affinity group",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the account owning the affinity group",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the project name of the affinity group",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the description of the affinity group",
- "name": "description",
- "type": "string"
- },
- {
- "description": "the name of the affinity group",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the type of the affinity group",
- "name": "type",
- "type": "string"
- },
- {
- "description": "the project ID of the affinity group",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the domain name of the affinity group",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "virtual machine IDs associated with this affinity group",
- "name": "virtualmachineIds",
- "type": "list"
- },
- {
- "description": "the domain ID of the affinity group",
- "name": "domainid",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the 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": "true if the password rest feature is enabled, false otherwise",
- "name": "passwordenabled",
- "type": "boolean"
- },
- {
- "description": "Guest vm Boot Mode",
- "name": "bootmode",
- "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",
- "type": "string"
- },
- {
- "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.",
- "name": "templateid",
- "type": "string"
- },
- {
- "description": "the name of the template for the virtual machine",
- "name": "templatename",
- "type": "string"
- },
- {
- "description": "instance name of the user vm; this parameter is returned to the ROOT admin only",
- "name": "instancename",
- "type": "string"
- },
- {
- "description": "the ID of the availablility zone for the virtual machine",
- "name": "zoneid",
- "type": "string"
- },
- {
- "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 broadcast uri of the nic",
- "name": "broadcasturi",
- "type": "string"
- },
- {
- "description": "Id of the vm to which the nic belongs",
- "name": "virtualmachineid",
- "type": "string"
- },
- {
- "description": "the gateway of IPv6 network",
- "name": "ip6gateway",
- "type": "string"
- },
- {
- "description": "the traffic type of the nic",
- "name": "traffictype",
- "type": "string"
- },
- {
- "description": "IP addresses associated with NIC found for unmanaged VM",
- "name": "ipaddresses",
- "type": "list"
- },
- {
- "description": "Type of adapter if available",
- "name": "adaptertype",
- "type": "string"
- },
- {
- "description": "the netmask of the nic",
- "name": "netmask",
- "type": "string"
- },
- {
- "description": "the isolated private VLAN if available",
- "name": "isolatedpvlan",
- "type": "integer"
- },
- {
- "description": "the isolation uri of the nic",
- "name": "isolationuri",
- "type": "string"
- },
- {
- "description": "the type of the nic",
- "name": "type",
- "type": "string"
- },
- {
- "description": "the cidr of IPv6 network",
- "name": "ip6cidr",
- "type": "string"
- },
- {
- "description": "the isolated private VLAN type if available",
- "name": "isolatedpvlantype",
- "type": "string"
- },
- {
- "description": "the 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 Secondary ipv4 addr of nic",
- "name": "secondaryip",
- "type": "list"
- },
- {
- "description": "the extra dhcp options on the nic",
- "name": "extradhcpoption",
- "type": "list"
- },
- {
- "description": "the ip address of the nic",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "description": "the ID of the nic",
- "name": "id",
- "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 gateway of the nic",
- "name": "gateway",
- "type": "string"
- },
- {
- "description": "the IPv6 address of network",
- "name": "ip6address",
- "type": "string"
- },
- {
- "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise",
- "name": "nsxlogicalswitchport",
- "type": "string"
- },
- {
- "description": "ID of the VLAN/VNI if available",
- "name": "vlanid",
- "type": "integer"
- },
- {
- "description": "true if nic is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
- }
- ],
- "type": "set"
- },
- {
- "description": "the ID of the service offering of the virtual machine",
- "name": "serviceofferingid",
- "type": "string"
- },
- {
- "description": "the name of the service offering of the virtual machine",
- "name": "serviceofferingname",
- "type": "string"
- },
- {},
- {
- "description": "the ID of the domain in which the virtual machine exists",
- "name": "domainid",
+ "description": "the project id of the vm",
+ "name": "projectid",
"type": "string"
},
{
@@ -18212,23 +18264,8 @@
"type": "boolean"
},
{
- "description": "the incoming network traffic on the vm",
- "name": "networkkbsread",
- "type": "long"
- },
- {
- "description": "the ID of the backup offering of the virtual machine",
- "name": "backupofferingid",
- "type": "string"
- },
- {
- "description": "an alternate display text of the ISO attached to the virtual machine",
- "name": "isodisplaytext",
- "type": "string"
- },
- {
- "description": "the user's ID who deployed the virtual machine",
- "name": "userid",
+ "description": "OS type id of the vm",
+ "name": "ostypeid",
"type": "string"
},
{
@@ -18237,18 +18274,64 @@
"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 service offering of the virtual machine",
+ "name": "serviceofferingid",
+ "type": "string"
},
+ {},
{
- "description": "device type of the root volume",
- "name": "rootdevicetype",
+ "description": "Guest vm Boot Mode",
+ "name": "bootmode",
"type": "string"
},
{
- "description": "the name of the virtual machine",
- "name": "name",
+ "description": "Vm details in key/value pairs.",
+ "name": "details",
+ "type": "map"
+ },
+ {
+ "description": "instance name of the user vm; this parameter is returned to the ROOT admin only",
+ "name": "instancename",
+ "type": "string"
+ },
+ {
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "description": "the ID of the availablility zone for the virtual machine",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the password (if exists) of the virtual machine",
+ "name": "password",
+ "type": "string"
+ },
+ {
+ "description": "List of read-only Vm details as comma separated string.",
+ "name": "readonlydetails",
+ "type": "string"
+ },
+ {
+ "description": "public IP address id associated with vm via Static nat rule",
+ "name": "publicip",
+ "type": "string"
+ },
+ {
+ "description": "device ID of the root volume",
+ "name": "rootdeviceid",
+ "type": "long"
+ },
+ {
+ "description": "State of the Service from LB rule",
+ "name": "servicestate",
+ "type": "string"
+ },
+ {
+ "description": "an alternate display text of the ISO attached to the virtual machine",
+ "name": "isodisplaytext",
"type": "string"
},
{
@@ -18257,124 +18340,41 @@
"type": "string"
},
{
- "description": "the read (bytes) of disk on the vm",
- "name": "diskkbsread",
- "type": "long"
- },
- {
- "description": "the account associated with the virtual machine",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the name of the domain in which the virtual machine exists",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the 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 state of the virtual machine",
- "name": "state",
- "type": "string"
- },
- {
- "description": "the name of the ISO attached to the virtual machine",
- "name": "isoname",
- "type": "string"
- },
- {
- "description": "the total number of network traffic bytes received",
- "name": "receivedbytes",
- "type": "long"
- },
- {
- "description": "the date when this virtual machine was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "State of the Service from LB rule",
- "name": "servicestate",
- "type": "string"
- },
- {
- "description": "the amount of the vm's CPU currently used",
- "name": "cpuused",
- "type": "string"
- },
- {
- "description": "the group name of the virtual machine",
- "name": "group",
- "type": "string"
- },
- {
- "description": " an alternate display text of the template for the virtual machine",
- "name": "templatedisplaytext",
- "type": "string"
- },
- {
- "description": "the outgoing network traffic on the host",
- "name": "networkkbswrite",
- "type": "long"
- },
- {
- "description": "Guest vm Boot Type",
- "name": "boottype",
- "type": "string"
- },
- {
- "description": "the speed of each cpu",
- "name": "cpuspeed",
- "type": "integer"
- },
- {
- "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": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
- },
- {
- "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 write (io) of disk on the vm",
- "name": "diskiowrite",
- "type": "long"
+ "description": "the ID of the backup offering of the virtual machine",
+ "name": "backupofferingid",
+ "type": "string"
},
+ {},
{
- "description": "public IP address id associated with vm via Static nat rule",
- "name": "publicip",
+ "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 write (bytes) of disk on the vm",
- "name": "diskkbswrite",
+ "description": "the internal memory that's free in vm or zero if it can not be calculated",
+ "name": "memoryintfreekbs",
"type": "long"
+ },
+ {
+ "description": "the group ID of the virtual machine",
+ "name": "groupid",
+ "type": "string"
+ },
+ {
+ "description": "the date when this virtual machine was updated last time",
+ "name": "lastupdated",
+ "type": "date"
}
]
},
@@ -18398,19 +18398,19 @@
"name": "jobid",
"type": "string"
},
- {},
- {},
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
{
"description": "true if operation is executed successfully",
"name": "success",
"type": "boolean"
},
{
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {},
+ {},
+ {
"description": "any text associated with the success or failure",
"name": "displaytext",
"type": "string"
@@ -18424,11 +18424,12 @@
"name": "createLoadBalancerRule",
"params": [
{
- "description": "the CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,). This parameter is deprecated. Do not use.",
+ "description": "The guest network this rule will be created for. Required when public Ip address is not associated with any Guest network yet (VPC case)",
"length": 255,
- "name": "cidrlist",
+ "name": "networkid",
+ "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks",
"required": false,
- "type": "list"
+ "type": "uuid"
},
{
"description": "an optional field, whether to the display the rule to the end user or not",
@@ -18439,13 +18440,6 @@
"type": "boolean"
},
{
- "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": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitely. 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": "openfirewall",
@@ -18461,12 +18455,11 @@
"type": "uuid"
},
{
- "description": "The guest network this rule will be created for. Required when public Ip address is not associated with any Guest network yet (VPC case)",
+ "description": "the account associated with the load balancer. Must be used with the domainId parameter.",
"length": 255,
- "name": "networkid",
- "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks",
+ "name": "account",
"required": false,
- "type": "uuid"
+ "type": "string"
},
{
"description": "The protocol for the LB such as tcp, udp or tcp-proxy.",
@@ -18476,6 +18469,34 @@
"type": "string"
},
{
+ "description": "name of the load balancer rule",
+ "length": 255,
+ "name": "name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "the description of the load balancer rule",
+ "length": 4096,
+ "name": "description",
+ "required": false,
+ "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 CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,). This parameter is deprecated. Do not use.",
+ "length": 255,
+ "name": "cidrlist",
+ "required": false,
+ "type": "list"
+ },
+ {
"description": "public IP address ID from where the network traffic will be load balanced from",
"length": 255,
"name": "publicipid",
@@ -18492,61 +18513,40 @@
"type": "uuid"
},
{
- "description": "the public port from where the network traffic will be load balanced from",
- "length": 255,
- "name": "publicport",
- "required": true,
- "type": "integer"
- },
- {
- "description": "name of the load balancer rule",
- "length": 255,
- "name": "name",
- "required": true,
- "type": "string"
- },
- {
- "description": "the account associated with the load balancer. Must be used with the domainId parameter.",
- "length": 255,
- "name": "account",
- "required": false,
- "type": "string"
- },
- {
- "description": "the description of the load balancer rule",
- "length": 4096,
- "name": "description",
- "required": false,
- "type": "string"
- },
- {
"description": "load balancer algorithm (source, roundrobin, leastconn)",
"length": 255,
"name": "algorithm",
"required": true,
"type": "string"
+ },
+ {
+ "description": "the public port from where the network traffic will be load balanced from",
+ "length": 255,
+ "name": "publicport",
+ "required": true,
+ "type": "integer"
}
],
"related": "listLoadBalancerRules,updateLoadBalancerRule",
"response": [
{
- "description": "the id of the zone the rule belongs to",
- "name": "zoneid",
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the domain of the load balancer rule",
+ "name": "domain",
"type": "string"
},
{
- "description": "the id of the guest network the lb rule belongs to",
- "name": "networkid",
+ "description": "the name of the zone the load balancer rule belongs to",
+ "name": "zonename",
"type": "string"
},
{
- "description": "the description of the load balancer",
- "name": "description",
- "type": "string"
- },
- {
- "description": "the public port",
- "name": "publicport",
+ "description": "the protocol of the loadbalanacer rule",
+ "name": "protocol",
"type": "string"
},
{
@@ -18555,28 +18555,13 @@
"type": "string"
},
{
- "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).",
- "name": "cidrlist",
+ "description": "the description of the load balancer",
+ "name": "description",
"type": "string"
},
{
- "description": "the load balancer algorithm (source, roundrobin, leastconn)",
- "name": "algorithm",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the project id of the load balancer",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the domain of the load balancer rule",
- "name": "domain",
+ "description": "the id of the guest network the lb rule belongs to",
+ "name": "networkid",
"type": "string"
},
{
@@ -18584,31 +18569,11 @@
"name": "tags",
"response": [
{
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
"description": "resource type",
"name": "resourcetype",
"type": "string"
},
{
- "description": "the 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"
@@ -18619,8 +18584,8 @@
"type": "string"
},
{
- "description": "the project id the tag belongs to",
- "name": "projectid",
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
"type": "string"
},
{
@@ -18629,47 +18594,77 @@
"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 domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
}
],
"type": "list"
},
{
- "description": "the load balancer rule ID",
- "name": "id",
- "type": "string"
- },
- {
"description": "the state of the rule",
"name": "state",
"type": "string"
},
{},
{
- "description": "the domain ID of the load balancer rule",
- "name": "domainid",
+ "description": "the name of the load balancer",
+ "name": "name",
"type": "string"
},
{
- "description": "the protocol of the loadbalanacer rule",
- "name": "protocol",
+ "description": "the private port",
+ "name": "privateport",
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
"description": "the account of the load balancer rule",
"name": "account",
"type": "string"
},
{
- "description": "the name of the load balancer",
- "name": "name",
+ "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 UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the project id of the load balancer",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the id of the zone the rule belongs to",
+ "name": "zoneid",
"type": "string"
},
{
@@ -18678,25 +18673,30 @@
"type": "boolean"
},
{
- "description": "the private port",
- "name": "privateport",
+ "description": "the public port",
+ "name": "publicport",
+ "type": "string"
+ },
+ {
+ "description": "the load balancer rule ID",
+ "name": "id",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).",
+ "name": "cidrlist",
+ "type": "string"
+ },
+ {
+ "description": "the load balancer algorithm (source, roundrobin, leastconn)",
+ "name": "algorithm",
"type": "string"
},
{
"description": "the public ip address",
"name": "publicip",
"type": "string"
- },
- {
- "description": "the project name of the load balancer",
- "name": "project",
- "type": "string"
- },
- {},
- {
- "description": "the name of the zone the load balancer rule belongs to",
- "name": "zonename",
- "type": "string"
}
]
},
@@ -18716,14 +18716,11 @@
],
"related": "listVsphereStoragePolicies",
"response": [
+ {},
+ {},
{
- "description": "the ID of the Storage Policy",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the name of the Storage Policy",
+ "name": "name",
"type": "string"
},
{
@@ -18732,27 +18729,30 @@
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
"description": "the description of the Storage Policy",
"name": "description",
"type": "string"
},
{
- "description": "the name of the Storage Policy",
- "name": "name",
+ "description": "the ID of the Storage Policy",
+ "name": "id",
"type": "string"
},
{
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
"description": "the ID of the Zone",
"name": "zoneid",
"type": "string"
},
- {},
- {}
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ }
]
},
{
@@ -18761,20 +18761,6 @@
"name": "addGuestOsMapping",
"params": [
{
- "description": "OS name specific to the hypervisor",
- "length": 255,
- "name": "osnameforhypervisor",
- "required": true,
- "type": "string"
- },
- {
- "description": "Hypervisor type. One of : XenServer, KVM, VMWare",
- "length": 255,
- "name": "hypervisor",
- "required": true,
- "type": "string"
- },
- {
"description": "UUID of Guest OS type. Either the UUID or Display Name must be passed",
"length": 255,
"name": "ostypeid",
@@ -18790,20 +18776,49 @@
"type": "string"
},
{
+ "description": "Hypervisor type. One of : XenServer, KVM, VMWare",
+ "length": 255,
+ "name": "hypervisor",
+ "required": true,
+ "type": "string"
+ },
+ {
"description": "Display Name of Guest OS standard type. Either Display Name or UUID must be passed",
"length": 255,
"name": "osdisplayname",
"required": false,
"type": "string"
+ },
+ {
+ "description": "OS name specific to the hypervisor",
+ "length": 255,
+ "name": "osnameforhypervisor",
+ "required": true,
+ "type": "string"
}
],
"related": "updateGuestOsMapping",
"response": [
+ {
+ "description": "the ID of the Guest OS mapping",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "is the mapping user defined",
+ "name": "isuserdefined",
+ "type": "string"
+ },
+ {
+ "description": "standard display name for the Guest OS",
+ "name": "osdisplayname",
+ "type": "string"
+ },
{},
{},
{
- "description": "version of the hypervisor for mapping",
- "name": "hypervisorversion",
+ "description": "the hypervisor",
+ "name": "hypervisor",
"type": "string"
},
{
@@ -18812,23 +18827,8 @@
"type": "string"
},
{
- "description": "the ID of the Guest OS type",
- "name": "ostypeid",
- "type": "string"
- },
- {
- "description": "standard display name for the Guest OS",
- "name": "osdisplayname",
- "type": "string"
- },
- {
- "description": "the hypervisor",
- "name": "hypervisor",
- "type": "string"
- },
- {
- "description": "hypervisor specific name for the Guest OS",
- "name": "osnameforhypervisor",
+ "description": "version of the hypervisor for mapping",
+ "name": "hypervisorversion",
"type": "string"
},
{
@@ -18837,13 +18837,13 @@
"type": "integer"
},
{
- "description": "is the mapping user defined",
- "name": "isuserdefined",
+ "description": "the ID of the Guest OS type",
+ "name": "ostypeid",
"type": "string"
},
{
- "description": "the ID of the Guest OS mapping",
- "name": "id",
+ "description": "hypervisor specific name for the Guest OS",
+ "name": "osnameforhypervisor",
"type": "string"
}
],
@@ -18865,14 +18865,15 @@
],
"related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,enableOutOfBandManagementForZone,issueOutOfBandManagementPowerAction,changeOutOfBandManagementPassword",
"response": [
+ {},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the ID of the host",
+ "name": "hostid",
"type": "string"
},
{
- "description": "true if out-of-band management is enabled for the host",
- "name": "enabled",
+ "description": "the operation result",
+ "name": "status",
"type": "boolean"
},
{
@@ -18881,27 +18882,11 @@
"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",
- "type": "string"
- },
- {},
- {
"description": "the out-of-band management interface password",
"name": "password",
"type": "string"
},
{
- "description": "the operation result",
- "name": "status",
- "type": "boolean"
- },
- {
"description": "the out-of-band management interface powerState of the host",
"name": "powerstate",
"type": "powerstate"
@@ -18912,15 +18897,19 @@
"type": "string"
},
{
- "description": "the out-of-band management interface address",
- "name": "address",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
- {},
{
- "description": "the operation result description",
- "name": "description",
- "type": "string"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "true if out-of-band management is enabled for the host",
+ "name": "enabled",
+ "type": "boolean"
},
{
"description": "the out-of-band management interface username",
@@ -18928,8 +18917,19 @@
"type": "string"
},
{
- "description": "the ID of the host",
- "name": "hostid",
+ "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 description",
+ "name": "description",
"type": "string"
}
],
@@ -18959,25 +18959,56 @@
"related": "addF5LoadBalancer,listF5LoadBalancers",
"response": [
{
+ "description": "the physical network to which this F5 device belongs to",
+ "name": "physicalnetworkid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "device capacity",
+ "name": "lbdevicecapacity",
+ "type": "long"
+ },
+ {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
- {},
{
"description": "device state",
"name": "lbdevicestate",
"type": "string"
},
{
+ "description": "device name",
+ "name": "lbdevicename",
+ "type": "string"
+ },
+ {},
+ {
"description": "the management IP address of the external load balancer",
"name": "ipaddress",
"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": "device id of the F5 load balancer",
+ "name": "lbdeviceid",
+ "type": "string"
+ },
+ {
+ "description": "the private interface of the load balancer",
+ "name": "privateinterface",
+ "type": "string"
+ },
+ {
+ "description": "name of the provider",
+ "name": "provider",
+ "type": "string"
},
{
"description": "the public interface of the load balancer",
@@ -18988,37 +19019,6 @@
"description": "true if device is dedicated for an account",
"name": "lbdevicededicated",
"type": "boolean"
- },
- {
- "description": "the private interface of the load balancer",
- "name": "privateinterface",
- "type": "string"
- },
- {},
- {
- "description": "device id of the F5 load balancer",
- "name": "lbdeviceid",
- "type": "string"
- },
- {
- "description": "device name",
- "name": "lbdevicename",
- "type": "string"
- },
- {
- "description": "name of the provider",
- "name": "provider",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the physical network to which this F5 device belongs to",
- "name": "physicalnetworkid",
- "type": "string"
}
]
},
@@ -19028,6 +19028,42 @@
"name": "updateNetworkOffering",
"params": [
{
+ "description": "the id of the network offering",
+ "length": 255,
+ "name": "id",
+ "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "the name of the network offering",
+ "length": 255,
+ "name": "name",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the display text of the network offering",
+ "length": 255,
+ "name": "displaytext",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "maximum number of concurrent connections supported by the network offering",
+ "length": 255,
+ "name": "maxconnections",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "sort key of the network offering, integer",
+ "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": 255,
"name": "domainid",
@@ -19035,20 +19071,6 @@
"type": "string"
},
{
- "description": "the tags for the network offering.",
- "length": 4096,
- "name": "tags",
- "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": 255,
"name": "zoneid",
@@ -19057,9 +19079,9 @@
"type": "string"
},
{
- "description": "the display text of the network offering",
- "length": 255,
- "name": "displaytext",
+ "description": "the tags for the network offering.",
+ "length": 4096,
+ "name": "tags",
"required": false,
"type": "string"
},
@@ -19071,11 +19093,11 @@
"type": "boolean"
},
{
- "description": "sort key of the network offering, integer",
+ "description": "update state for the network offering",
"length": 255,
- "name": "sortkey",
+ "name": "state",
"required": false,
- "type": "integer"
+ "type": "string"
},
{
"description": "the availability of network offering. Default value is Required for Guest Virtual network offering; Optional for Guest Direct network offering",
@@ -19083,99 +19105,11 @@
"name": "availability",
"required": false,
"type": "string"
- },
- {
- "description": "the id of the network offering",
- "length": 255,
- "name": "id",
- "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "maximum number of concurrent connections supported by the network offering",
- "length": 255,
- "name": "maxconnections",
- "required": false,
- "type": "integer"
- },
- {
- "description": "the name of the network offering",
- "length": 255,
- "name": "name",
- "required": false,
- "type": "string"
}
],
"related": "createNetworkOffering,listNetworkOfferings",
"response": [
{
- "description": "true if network offering supports network that span multiple zones",
- "name": "supportsstrechedl2subnet",
- "type": "boolean"
- },
- {
- "description": "availability of the network offering",
- "name": "availability",
- "type": "string"
- },
- {
- "description": "an alternate display text of the network offering.",
- "name": "displaytext",
- "type": "string"
- },
- {
- "description": "true if network offering is ip conserve mode enabled",
- "name": "conservemode",
- "type": "boolean"
- },
- {
- "description": "the name of the network offering",
- "name": "name",
- "type": "string"
- },
- {
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.",
- "name": "traffictype",
- "type": "string"
- },
- {
- "description": "true if network offering is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
- },
- {
- "description": "true if network offering supports vlans, false otherwise",
- "name": "specifyvlan",
- "type": "boolean"
- },
- {
- "description": "additional key/value details tied with network offering",
- "name": "details",
- "type": "map"
- },
- {
- "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": "guest type of the network offering, can be Shared or Isolated",
"name": "guestiptype",
"type": "string"
@@ -19186,57 +19120,122 @@
"type": "string"
},
{
+ "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
+ "name": "domain",
+ "type": "string"
+ },
+ {
"description": "the id of the network offering",
"name": "id",
"type": "string"
},
{
+ "description": "data transfer rate in megabits per second allowed.",
+ "name": "networkrate",
+ "type": "integer"
+ },
+ {
+ "description": "state of the network offering. Can be Disabled/Enabled/Inactive",
+ "name": "state",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the tags for the network offering",
+ "name": "tags",
+ "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": "true if network offering supports persistent networks, false otherwise",
"name": "ispersistent",
"type": "boolean"
},
{
+ "description": "true if network offering can be used by VPC networks only",
+ "name": "forvpc",
+ "type": "boolean"
+ },
+ {
+ "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
+ "name": "zone",
+ "type": "string"
+ },
+ {
+ "description": "true if network offering supports network that span multiple zones",
+ "name": "supportsstrechedl2subnet",
+ "type": "boolean"
+ },
+ {
+ "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.",
+ "name": "traffictype",
+ "type": "string"
+ },
+ {
"description": "true if guest network default egress policy is allow; false if default egress policy is deny",
"name": "egressdefaultpolicy",
"type": "boolean"
},
{
- "description": "state of the network offering. Can be Disabled/Enabled/Inactive",
- "name": "state",
+ "description": "true if network offering supports specifying ip ranges, false otherwise",
+ "name": "specifyipranges",
+ "type": "boolean"
+ },
+ {
+ "description": "the ID of the service offering used by virtual router provider",
+ "name": "serviceofferingid",
"type": "string"
},
{
+ "description": "true if network offering supports 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": "the name of the network offering",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the date this network offering was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "maximum number of concurrents connections to be handled by lb",
+ "name": "maxconnections",
+ "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": "availability of the network offering",
+ "name": "availability",
+ "type": "string"
+ },
+ {},
+ {
"description": "the list of supported services",
"name": "service",
"response": [
{
- "description": "the list of capabilities",
- "name": "capability",
- "response": [
- {
- "description": "the capability name",
- "name": "name",
- "type": "string"
- },
- {
- "description": "can this service capability value can be choosable while creatine network offerings",
- "name": "canchooseservicecapability",
- "type": "boolean"
- },
- {
- "description": "the capability value",
- "name": "value",
- "type": "string"
- }
- ],
- "type": "list"
- },
- {
- "description": "the service name",
- "name": "name",
- "type": "string"
- },
- {
"description": "the service provider name",
"name": "provider",
"response": [
@@ -19256,11 +19255,6 @@
"type": "string"
},
{
- "description": "services for this provider",
- "name": "servicelist",
- "type": "list"
- },
- {
"description": "the provider name",
"name": "name",
"type": "string"
@@ -19274,6 +19268,38 @@
"description": "the physical network this belongs to",
"name": "physicalnetworkid",
"type": "string"
+ },
+ {
+ "description": "services for this provider",
+ "name": "servicelist",
+ "type": "list"
+ }
+ ],
+ "type": "list"
+ },
+ {
+ "description": "the service name",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the list of capabilities",
+ "name": "capability",
+ "response": [
+ {
+ "description": "the capability name",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "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"
@@ -19282,55 +19308,29 @@
"type": "list"
},
{
- "description": "true if network offering can be used by VPC networks only",
- "name": "forvpc",
+ "description": "true if network offering is default, false otherwise",
+ "name": "isdefault",
"type": "boolean"
},
{
+ "description": "true if network offering is ip conserve mode enabled",
+ "name": "conservemode",
+ "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 offering supports public access for guest networks",
"name": "supportspublicaccess",
"type": "boolean"
- },
- {
- "description": "the date this network offering was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
- "name": "zone",
- "type": "string"
- },
- {
- "description": "the ID of the service offering used by virtual router provider",
- "name": "serviceofferingid",
- "type": "string"
- },
- {
- "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "true if network offering supports specifying ip ranges, false otherwise",
- "name": "specifyipranges",
- "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": "maximum number of concurrents connections to be handled by lb",
- "name": "maxconnections",
- "type": "integer"
- },
- {
- "description": "the tags for the network offering",
- "name": "tags",
- "type": "string"
}
]
},
@@ -19340,52 +19340,112 @@
"name": "stopSystemVm",
"params": [
{
- "description": "Force stop the VM. The caller knows the VM is stopped.",
- "length": 255,
- "name": "forced",
- "required": false,
- "type": "boolean"
- },
- {
"description": "The ID of the system virtual machine",
"length": 255,
"name": "id",
"related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm",
"required": true,
"type": "uuid"
+ },
+ {
+ "description": "Force stop the VM. The caller knows the VM is stopped.",
+ "length": 255,
+ "name": "forced",
+ "required": false,
+ "type": "boolean"
}
],
"related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm",
"response": [
{
- "description": "the name of the system VM",
- "name": "name",
+ "description": "the state of the system VM",
+ "name": "state",
"type": "string"
},
{
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
+ "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.",
+ "name": "isdynamicallyscalable",
"type": "boolean"
},
{
+ "description": "the 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 number of active console sessions for the console proxy system vm",
+ "name": "activeviewersessions",
+ "type": "integer"
+ },
+ {
+ "description": "the link local MAC address for the system vm",
+ "name": "linklocalmacaddress",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the private MAC address for the system VM",
+ "name": "privatemacaddress",
+ "type": "string"
+ },
+ {
+ "description": "the system VM type",
+ "name": "systemvmtype",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the system VM",
+ "name": "id",
+ "type": "string"
+ },
+ {
"description": "the last disconnected date of host",
"name": "disconnected",
"type": "date"
},
{
- "description": "the gateway for the system VM",
- "name": "gateway",
+ "description": "the Pod name for the system VM",
+ "name": "podname",
"type": "string"
},
{
- "description": "public vlan range",
- "name": "publicvlan",
- "type": "list"
+ "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.",
- "name": "jobstatus",
- "type": "integer"
+ "description": "the private netmask for the system VM",
+ "name": "privatenetmask",
+ "type": "string"
+ },
+ {
+ "description": "the hypervisor on which the template runs",
+ "name": "hypervisor",
+ "type": "string"
+ },
+ {
+ "description": "the hostname for the system VM",
+ "name": "hostname",
+ "type": "string"
+ },
+ {
+ "description": "the host ID for the system VM",
+ "name": "hostid",
+ "type": "string"
+ },
+ {
+ "description": "the second DNS for the system VM",
+ "name": "dns2",
+ "type": "string"
},
{
"description": "the template ID for the system VM",
@@ -19394,6 +19454,22 @@
},
{},
{
+ "description": "the private IP address for the system VM",
+ "name": "privateip",
+ "type": "string"
+ },
+ {
+ "description": "the public IP address for the system VM",
+ "name": "publicip",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the name of the system VM",
+ "name": "name",
+ "type": "string"
+ },
+ {
"description": "the agent state of the system VM",
"name": "agentstate",
"type": "string"
@@ -19404,11 +19480,71 @@
"type": "string"
},
{
+ "description": "the systemvm agent version",
+ "name": "version",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
"description": "the public MAC address for the system VM",
"name": "publicmacaddress",
"type": "string"
},
{
+ "description": "the Zone name for the system VM",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "the public netmask for the system VM",
+ "name": "publicnetmask",
+ "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 gateway for the system VM",
+ "name": "gateway",
+ "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 IP address for the system vm",
+ "name": "linklocalip",
+ "type": "string"
+ },
+ {
+ "description": "public vlan range",
+ "name": "publicvlan",
+ "type": "list"
+ },
+ {
+ "description": "the first DNS for the system VM",
+ "name": "dns1",
+ "type": "string"
+ },
+ {
+ "description": "the network domain for the system VM",
+ "name": "networkdomain",
+ "type": "string"
+ },
+ {
"description": "the link local netmask for the system vm",
"name": "linklocalnetmask",
"type": "string"
@@ -19417,142 +19553,6 @@
"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 second DNS for the system VM",
- "name": "dns2",
- "type": "string"
- },
- {
- "description": "the public IP address for the system VM",
- "name": "publicip",
- "type": "string"
- },
- {
- "description": "the Pod ID for the system VM",
- "name": "podid",
- "type": "string"
- },
- {
- "description": "the network domain for the system VM",
- "name": "networkdomain",
- "type": "string"
- },
- {
- "description": "the first DNS for the system VM",
- "name": "dns1",
- "type": "string"
- },
- {
- "description": "the host ID for the system VM",
- "name": "hostid",
- "type": "string"
- },
- {
- "description": "the hostname for the system VM",
- "name": "hostname",
- "type": "string"
- },
- {
- "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.",
- "name": "isdynamicallyscalable",
- "type": "boolean"
- },
- {
- "description": "the private netmask for the system VM",
- "name": "privatenetmask",
- "type": "string"
- },
- {
- "description": "the date and time the system VM was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the private IP address for the system VM",
- "name": "privateip",
- "type": "string"
- },
- {
- "description": "the link local IP address for the system vm",
- "name": "linklocalip",
- "type": "string"
- },
- {
- "description": "the ID of the system VM",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the link local MAC address for the system vm",
- "name": "linklocalmacaddress",
- "type": "string"
- },
- {
- "description": "the Pod name for the system VM",
- "name": "podname",
- "type": "string"
- },
- {},
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the hypervisor on which the template runs",
- "name": "hypervisor",
- "type": "string"
- },
- {
- "description": "the state of the system VM",
- "name": "state",
- "type": "string"
- },
- {
- "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 Zone ID for the system VM",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the systemvm agent version",
- "name": "version",
- "type": "string"
- },
- {
- "description": "guest vlan range",
- "name": "guestvlan",
- "type": "string"
- },
- {
- "description": "the public netmask for the system VM",
- "name": "publicnetmask",
- "type": "string"
- },
- {
- "description": "the system VM type",
- "name": "systemvmtype",
- "type": "string"
- },
- {
- "description": "the private MAC address for the system VM",
- "name": "privatemacaddress",
- "type": "string"
}
]
},
@@ -19571,10 +19571,11 @@
}
],
"response": [
+ {},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
{
"description": "true if operation is executed successfully",
@@ -19582,16 +19583,15 @@
"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"
+ },
{}
]
},
@@ -19601,13 +19601,6 @@
"name": "updateVPC",
"params": [
{
- "description": "the display text of the VPC",
- "length": 255,
- "name": "displaytext",
- "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",
@@ -19616,6 +19609,13 @@
"type": "string"
},
{
+ "description": "the name of the VPC",
+ "length": 255,
+ "name": "name",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "the id of the VPC",
"length": 255,
"name": "id",
@@ -19632,9 +19632,9 @@
"type": "boolean"
},
{
- "description": "the name of the VPC",
+ "description": "the display text of the VPC",
"length": 255,
- "name": "name",
+ "name": "displaytext",
"required": false,
"type": "string"
}
@@ -19642,116 +19642,59 @@
"related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC",
"response": [
{
+ "description": "the cidr the VPC",
+ "name": "cidr",
+ "type": "string"
+ },
+ {
"description": "Base64 string representation of the resource icon",
"name": "icon",
"type": "resourceiconresponse"
},
{
- "description": "the domain name of the owner",
- "name": "domain",
+ "description": "the owner of the VPC",
+ "name": "account",
"type": "string"
},
- {
- "description": "the list of networks belongign to the VPC",
- "name": "network",
- "type": "list"
- },
- {
- "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": "true if the entity/resource has annotations",
"name": "hasannotations",
"type": "boolean"
},
{
+ "description": "is vpc for display to the regular user",
+ "name": "fordisplay",
+ "type": "boolean"
+ },
+ {
+ "description": "the id of the VPC",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "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",
+ "type": "boolean"
+ },
+ {
"description": "an alternate display text of the VPC.",
"name": "displaytext",
"type": "string"
},
{
- "description": "if this VPC has redundant router",
- "name": "redundantvpcrouter",
- "type": "boolean"
- },
- {},
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "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 list of resource tags associated with the project",
- "name": "tags",
- "response": [
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "the 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": "list"
- },
- {
- "description": "the id of the VPC",
- "name": "id",
+ "description": "the domain name of the owner",
+ "name": "domain",
"type": "string"
},
{
@@ -19763,11 +19706,6 @@
"name": "capability",
"response": [
{
- "description": "the capability name",
- "name": "name",
- "type": "string"
- },
- {
"description": "the capability value",
"name": "value",
"type": "string"
@@ -19776,11 +19714,21 @@
"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",
+ "type": "string"
+ },
+ {
"description": "the service provider name",
"name": "provider",
"response": [
@@ -19790,8 +19738,8 @@
"type": "string"
},
{
- "description": "the destination physical network",
- "name": "destinationphysicalnetworkid",
+ "description": "uuid of the network provider",
+ "name": "id",
"type": "string"
},
{
@@ -19800,8 +19748,8 @@
"type": "boolean"
},
{
- "description": "uuid of the network provider",
- "name": "id",
+ "description": "the provider name",
+ "name": "name",
"type": "string"
},
{
@@ -19810,8 +19758,8 @@
"type": "list"
},
{
- "description": "the provider name",
- "name": "name",
+ "description": "the destination physical network",
+ "name": "destinationphysicalnetworkid",
"type": "string"
},
{
@@ -19821,38 +19769,80 @@
}
],
"type": "list"
+ }
+ ],
+ "type": "list"
+ },
+ {
+ "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": "the service name",
- "name": "name",
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
"type": "string"
}
],
"type": "list"
},
{
- "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's",
- "name": "distributedvpcrouter",
+ "description": "the date this VPC was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "true if VPC is region level",
+ "name": "regionlevelvpc",
"type": "boolean"
},
{
- "description": "vpc offering name the VPC is created from",
- "name": "vpcofferingname",
- "type": "string"
- },
- {
- "description": "the name of the zone the VPC belongs to",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "the cidr the VPC",
- "name": "cidr",
- "type": "string"
- },
- {
- "description": "the project name of the VPC",
- "name": "project",
+ "description": "the name of the VPC",
+ "name": "name",
"type": "string"
},
{
@@ -19861,18 +19851,8 @@
"type": "string"
},
{
- "description": "the project id of the VPC",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "true VPC requires restart",
- "name": "restartrequired",
- "type": "boolean"
- },
- {
- "description": "the owner of the VPC",
- "name": "account",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
@@ -19880,11 +19860,15 @@
"name": "vpcofferingid",
"type": "string"
},
- {},
{
- "description": "is vpc for display to the regular user",
- "name": "fordisplay",
- "type": "boolean"
+ "description": "the list of networks belongign to the VPC",
+ "name": "network",
+ "type": "list"
+ },
+ {
+ "description": "the project id of the VPC",
+ "name": "projectid",
+ "type": "string"
},
{
"description": "state of the VPC. Can be Inactive/Enabled",
@@ -19892,15 +19876,31 @@
"type": "string"
},
{
- "description": "the name of the VPC",
- "name": "name",
+ "description": "the name of the zone the VPC belongs to",
+ "name": "zonename",
"type": "string"
},
{
+ "description": "the project name of the VPC",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "if this VPC has redundant router",
+ "name": "redundantvpcrouter",
+ "type": "boolean"
+ },
+ {
"description": "zone id of the vpc",
"name": "zoneid",
"type": "string"
},
+ {},
{
"description": "the domain id of the VPC owner",
"name": "domainid",
@@ -19932,23 +19932,8 @@
"related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,enableOutOfBandManagementForZone,issueOutOfBandManagementPowerAction",
"response": [
{
- "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"
- },
- {
- "description": "the operation result description",
- "name": "description",
+ "description": "the out-of-band management interface username",
+ "name": "username",
"type": "string"
},
{
@@ -19958,19 +19943,18 @@
},
{},
{
+ "description": "the out-of-band management interface address",
+ "name": "address",
+ "type": "string"
+ },
+ {
"description": "the out-of-band management interface password",
"name": "password",
"type": "string"
},
{
- "description": "the out-of-band management interface 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"
},
{
@@ -19979,14 +19963,19 @@
"type": "boolean"
},
{
- "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 port",
+ "name": "port",
"type": "string"
},
{
- "description": "the out-of-band management interface address",
- "name": "address",
- "type": "string"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
{
"description": "the UUID of the latest async job acting on this object",
@@ -19994,6 +19983,17 @@
"type": "string"
},
{
+ "description": "true if out-of-band management is enabled for the host",
+ "name": "enabled",
+ "type": "boolean"
+ },
+ {},
+ {
+ "description": "the ID of the host",
+ "name": "hostid",
+ "type": "string"
+ },
+ {
"description": "the out-of-band management driver for the host",
"name": "driver",
"type": "string"
@@ -20007,13 +20007,6 @@
"name": "listResourceDetails",
"params": [
{
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
- },
- {
"description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false",
"length": 255,
"name": "listall",
@@ -20021,6 +20014,21 @@
"type": "boolean"
},
{
+ "description": "list by key",
+ "length": 255,
+ "name": "key",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "list only resources belonging to the domain specified",
+ "length": 255,
+ "name": "domainid",
+ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
+ "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",
@@ -20028,18 +20036,24 @@
"type": "boolean"
},
{
- "description": "if set to true, only details marked with display=true, are returned. False by default",
+ "description": "list by resource id",
"length": 255,
- "name": "fordisplay",
+ "name": "resourceid",
"required": false,
- "since": "4.3",
- "type": "boolean"
+ "type": "string"
},
{
- "description": "list by key",
+ "description": "",
"length": 255,
- "name": "key",
+ "name": "page",
"required": false,
+ "type": "integer"
+ },
+ {
+ "description": "list by resource type",
+ "length": 255,
+ "name": "resourcetype",
+ "required": true,
"type": "string"
},
{
@@ -20051,17 +20065,18 @@
"type": "string"
},
{
- "description": "",
+ "description": "if set to true, only details marked with display=true, are returned. False by default",
"length": 255,
- "name": "page",
+ "name": "fordisplay",
"required": false,
- "type": "integer"
+ "since": "4.3",
+ "type": "boolean"
},
{
- "description": "list only resources belonging to the domain specified",
+ "description": "list objects by project",
"length": 255,
- "name": "domainid",
- "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
+ "name": "projectid",
+ "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject",
"required": false,
"type": "uuid"
},
@@ -20080,24 +20095,9 @@
"type": "integer"
},
{
- "description": "list objects by project",
+ "description": "List by keyword",
"length": 255,
- "name": "projectid",
- "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "list by resource type",
- "length": 255,
- "name": "resourcetype",
- "required": true,
- "type": "string"
- },
- {
- "description": "list by resource id",
- "length": 255,
- "name": "resourceid",
+ "name": "keyword",
"required": false,
"type": "string"
}
@@ -20105,55 +20105,14 @@
"related": "listTags",
"response": [
{
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "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 current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
{},
{
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {},
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
+ "description": "the domain associated with the tag",
+ "name": "domain",
"type": "string"
},
{
@@ -20162,9 +20121,50 @@
"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 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": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
}
],
"since": "4.2"
@@ -20175,6 +20175,123 @@
"name": "createNetworkOffering",
"params": [
{
+ "description": "true if network offering supports persistent networks; defaulted to false if not specified",
+ "length": 255,
+ "name": "ispersistent",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "the display text of the network offering",
+ "length": 255,
+ "name": "displaytext",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "maximum number of concurrent connections supported by the network offering",
+ "length": 255,
+ "name": "maxconnections",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "the ID of the containing zone(s), null for public offerings",
+ "length": 255,
+ "name": "zoneid",
+ "related": "createZone,updateZone,listZones,listZones",
+ "required": false,
+ "since": "4.13",
+ "type": "list"
+ },
+ {
+ "description": "the service offering ID used by virtual router provider",
+ "length": 255,
+ "name": "serviceofferingid",
+ "related": "createServiceOffering,updateServiceOffering,listServiceOfferings",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "guest type of the network offering: Shared or Isolated",
+ "length": 255,
+ "name": "guestiptype",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "provider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical network",
+ "length": 255,
+ "name": "serviceproviderlist",
+ "required": false,
+ "type": "map"
+ },
+ {
+ "description": "data transfer rate in megabits per second allowed",
+ "length": 255,
+ "name": "networkrate",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "the ID of the containing domain(s), null for public offerings",
+ "length": 255,
+ "name": "domainid",
+ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
+ "required": false,
+ "type": "list"
+ },
+ {
+ "description": "Network offering details in key/value pairs. Supported keys are internallbprovider/publiclbprovider with service provider as a value, and promiscuousmode/macaddresschanges/forgedtransmits with true/false as value to accept/reject the security settings if available for a nic/portgroup",
+ "length": 255,
+ "name": "details",
+ "required": false,
+ "since": "4.2.0",
+ "type": "map"
+ },
+ {
+ "description": "true if network offering is meant to be used for VPC, false otherwise.",
+ "length": 255,
+ "name": "forvpc",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "true if network offering supports vlans",
+ "length": 255,
+ "name": "specifyvlan",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "if true keepalive will be turned on in the loadbalancer. At the time of writing this has only an effect on haproxy; the mode http and httpclose options are unset in the haproxy conf file.",
+ "length": 255,
+ "name": "keepaliveenabled",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "the name of the network offering",
+ "length": 255,
+ "name": "name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "services supported by the network offering",
+ "length": 255,
+ "name": "supportedservices",
+ "required": false,
+ "type": "list"
+ },
+ {
+ "description": "true if the network offering is IP conserve mode enabled",
+ "length": 255,
+ "name": "conservemode",
+ "required": false,
+ "type": "boolean"
+ },
+ {
"description": "the availability of network offering. Default value is Optional",
"length": 255,
"name": "availability",
@@ -20189,87 +20306,13 @@
"type": "boolean"
},
{
- "description": "true if network offering supports vlans",
+ "description": "the traffic type for the network offering. Supported type in current release is GUEST only",
"length": 255,
- "name": "specifyvlan",
- "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",
- "length": 255,
- "name": "serviceproviderlist",
- "required": false,
- "type": "map"
- },
- {
- "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 service offering ID used by virtual router provider",
- "length": 255,
- "name": "serviceofferingid",
- "related": "createServiceOffering,updateServiceOffering,listServiceOfferings",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "desired service capabilities as part of network offering",
- "length": 255,
- "name": "servicecapabilitylist",
- "required": false,
- "type": "map"
- },
- {
- "description": "services supported by the network offering",
- "length": 255,
- "name": "supportedservices",
- "required": false,
- "type": "list"
- },
- {
- "description": "the ID of the containing zone(s), null for public offerings",
- "length": 255,
- "name": "zoneid",
- "related": "createZone,updateZone,listZones,listZones",
- "required": false,
- "since": "4.13",
- "type": "list"
- },
- {
- "description": "the display text of the network offering",
- "length": 255,
- "name": "displaytext",
+ "name": "traffictype",
"required": true,
"type": "string"
},
{
- "description": "true if the network offering is IP conserve mode enabled",
- "length": 255,
- "name": "conservemode",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "the name of the network offering",
- "length": 255,
- "name": "name",
- "required": true,
- "type": "string"
- },
- {
- "description": "Network offering details in key/value pairs. Supported keys are internallbprovider/publiclbprovider with service provider as a value, and promiscuousmode/macaddresschanges/forgedtransmits with true/false as value to accept/reject the security settings if available for a nic/portgroup",
- "length": 255,
- "name": "details",
- "required": false,
- "since": "4.2.0",
- "type": "map"
- },
- {
"description": "true if guest network default egress policy is allow; false if default egress policy is deny",
"length": 255,
"name": "egressdefaultpolicy",
@@ -20277,21 +20320,6 @@
"type": "boolean"
},
{
- "description": "the ID of the containing domain(s), null for public offerings",
- "length": 255,
- "name": "domainid",
- "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
- "required": false,
- "type": "list"
- },
- {
- "description": "data transfer rate in megabits per second allowed",
- "length": 255,
- "name": "networkrate",
- "required": false,
- "type": "integer"
- },
- {
"description": "set to true if the offering is to be enabled during creation. Default is false",
"length": 255,
"name": "enable",
@@ -20300,39 +20328,11 @@
"type": "boolean"
},
{
- "description": "true if network offering supports persistent networks; defaulted to false if not specified",
+ "description": "desired service capabilities as part of network offering",
"length": 255,
- "name": "ispersistent",
+ "name": "servicecapabilitylist",
"required": false,
- "type": "boolean"
- },
- {
- "description": "the traffic type for the network offering. Supported type in current release is GUEST only",
- "length": 255,
- "name": "traffictype",
- "required": true,
- "type": "string"
- },
- {
- "description": "maximum number of concurrent connections supported by the network offering",
- "length": 255,
- "name": "maxconnections",
- "required": false,
- "type": "integer"
- },
- {
- "description": "guest type of the network offering: Shared or Isolated",
- "length": 255,
- "name": "guestiptype",
- "required": true,
- "type": "string"
- },
- {
- "description": "true if network offering is meant to be used for VPC, false otherwise.",
- "length": 255,
- "name": "forvpc",
- "required": false,
- "type": "boolean"
+ "type": "map"
},
{
"description": "the tags for the network offering.",
@@ -20344,130 +20344,23 @@
],
"related": "listNetworkOfferings",
"response": [
- {},
- {
- "description": "the tags for the network offering",
- "name": "tags",
- "type": "string"
- },
- {
- "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "true if network offering supports public access for guest networks",
- "name": "supportspublicaccess",
- "type": "boolean"
- },
- {
- "description": "an alternate display text of the network offering.",
- "name": "displaytext",
- "type": "string"
- },
- {
- "description": "true if network offering supports vlans, false otherwise",
- "name": "specifyvlan",
- "type": "boolean"
- },
- {
- "description": "state of the network offering. Can be Disabled/Enabled/Inactive",
- "name": "state",
- "type": "string"
- },
- {
- "description": "true if network offering supports persistent networks, false otherwise",
- "name": "ispersistent",
- "type": "boolean"
- },
- {
- "description": "additional key/value details tied with network offering",
- "name": "details",
- "type": "map"
- },
- {
- "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "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": "true if network offering supports network that span multiple zones",
- "name": "supportsstrechedl2subnet",
- "type": "boolean"
- },
- {
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "data transfer rate in megabits per second allowed.",
- "name": "networkrate",
- "type": "integer"
- },
- {
- "description": "true if network offering is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
- },
- {
- "description": "true if network offering can be used by VPC networks only",
- "name": "forvpc",
- "type": "boolean"
- },
- {
- "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "guest type of the network offering, can be Shared or Isolated",
- "name": "guestiptype",
- "type": "string"
- },
- {
- "description": "the date this network 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": "the ID of the service offering used by virtual router provider",
- "name": "serviceofferingid",
- "type": "string"
- },
- {
- "description": "true if network offering is ip conserve mode enabled",
- "name": "conservemode",
- "type": "boolean"
- },
{
"description": "the list of supported services",
"name": "service",
"response": [
{
+ "description": "the service name",
+ "name": "name",
+ "type": "string"
+ },
+ {
"description": "the service provider name",
"name": "provider",
"response": [
{
- "description": "true if individual services can be enabled/disabled",
- "name": "canenableindividualservice",
- "type": "boolean"
+ "description": "the destination physical network",
+ "name": "destinationphysicalnetworkid",
+ "type": "string"
},
{
"description": "services for this provider",
@@ -20475,13 +20368,8 @@
"type": "list"
},
{
- "description": "the physical network this belongs to",
- "name": "physicalnetworkid",
- "type": "string"
- },
- {
- "description": "uuid of the network provider",
- "name": "id",
+ "description": "the provider name",
+ "name": "name",
"type": "string"
},
{
@@ -20490,14 +20378,19 @@
"type": "string"
},
{
- "description": "the provider name",
- "name": "name",
+ "description": "uuid of the network provider",
+ "name": "id",
"type": "string"
},
{
- "description": "the destination physical network",
- "name": "destinationphysicalnetworkid",
+ "description": "the physical network this belongs to",
+ "name": "physicalnetworkid",
"type": "string"
+ },
+ {
+ "description": "true if individual services can be enabled/disabled",
+ "name": "canenableindividualservice",
+ "type": "boolean"
}
],
"type": "list"
@@ -20523,33 +20416,44 @@
}
],
"type": "list"
- },
- {
- "description": "the service name",
- "name": "name",
- "type": "string"
}
],
"type": "list"
},
{
- "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
- "name": "zone",
- "type": "string"
- },
- {
"description": "true if network offering supports specifying ip ranges, false otherwise",
"name": "specifyipranges",
"type": "boolean"
},
{
- "description": "the name of the network offering",
- "name": "name",
+ "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": "guest type of the network offering, can be Shared or Isolated",
+ "name": "guestiptype",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
+ "name": "domainid",
"type": "string"
},
{
- "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.",
- "name": "traffictype",
+ "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
+ "name": "zone",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the service offering used by virtual router provider",
+ "name": "serviceofferingid",
"type": "string"
},
{
@@ -20558,14 +20462,110 @@
"type": "string"
},
{
+ "description": "true if network offering supports public access for guest networks",
+ "name": "supportspublicaccess",
+ "type": "boolean"
+ },
+ {
+ "description": "true if network offering can be used by VPC networks only",
+ "name": "forvpc",
+ "type": "boolean"
+ },
+ {
+ "description": "state of the network offering. Can be Disabled/Enabled/Inactive",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "true if guest network default egress policy is allow; false if default egress policy is deny",
+ "name": "egressdefaultpolicy",
+ "type": "boolean"
+ },
+ {},
+ {
+ "description": "data transfer rate in megabits per second allowed.",
+ "name": "networkrate",
+ "type": "integer"
+ },
+ {
"description": "availability of the network offering",
"name": "availability",
"type": "string"
},
{
+ "description": "true if network offering is default, false otherwise",
+ "name": "isdefault",
+ "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": "the id of the network offering",
"name": "id",
"type": "string"
+ },
+ {
+ "description": "the tags for the network offering",
+ "name": "tags",
+ "type": "string"
+ },
+ {
+ "description": "maximum number of concurrents connections to be handled by lb",
+ "name": "maxconnections",
+ "type": "integer"
+ },
+ {
+ "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.",
+ "name": "traffictype",
+ "type": "string"
+ },
+ {
+ "description": "additional key/value details tied with network offering",
+ "name": "details",
+ "type": "map"
+ },
+ {
+ "description": "true if network offering is ip conserve mode enabled",
+ "name": "conservemode",
+ "type": "boolean"
+ },
+ {
+ "description": "the date this network offering was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "true if network offering supports persistent networks, false otherwise",
+ "name": "ispersistent",
+ "type": "boolean"
+ },
+ {
+ "description": "an alternate display text of the network offering.",
+ "name": "displaytext",
+ "type": "string"
+ },
+ {
+ "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "true if network offering supports vlans, false otherwise",
+ "name": "specifyvlan",
+ "type": "boolean"
+ },
+ {
+ "description": "the name of the network offering",
+ "name": "name",
+ "type": "string"
}
],
"since": "3.0.0"
@@ -20584,29 +20584,28 @@
"type": "uuid"
},
{
+ "description": "the name of the account which needs dedication. Must be used with domainId.",
+ "length": 255,
+ "name": "account",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "the ID of the Cluster",
"length": 255,
"name": "clusterid",
"related": "addCluster,updateCluster",
"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 ID of the cluster",
- "name": "clusterid",
+ "description": "the Dedication Affinity Group ID of the cluster",
+ "name": "affinitygroupid",
"type": "string"
},
- {},
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
@@ -20614,13 +20613,23 @@
},
{},
{
+ "description": "the Account ID of the cluster",
+ "name": "accountid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the cluster",
+ "name": "clustername",
+ "type": "string"
+ },
+ {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
{
- "description": "the ID of the dedicated resource",
- "name": "id",
+ "description": "the ID of the cluster",
+ "name": "clusterid",
"type": "string"
},
{
@@ -20629,20 +20638,11 @@
"type": "string"
},
{
- "description": "the Account ID of the cluster",
- "name": "accountid",
+ "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"
- }
+ {}
]
},
{
@@ -20651,13 +20651,6 @@
"name": "createIpForwardingRule",
"params": [
{
- "description": "the end port for the rule",
- "length": 255,
- "name": "endport",
- "required": false,
- "type": "integer"
- },
- {
"description": "the protocol for the rule. Valid values are TCP or UDP.",
"length": 255,
"name": "protocol",
@@ -20665,13 +20658,6 @@
"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"
- },
- {
"description": "the public IP address ID of the forwarding rule, already associated via associateIp",
"length": 255,
"name": "ipaddressid",
@@ -20680,11 +20666,11 @@
"type": "uuid"
},
{
- "description": "the start port for the rule",
+ "description": "the CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,). This parameter is deprecated. Do not use.",
"length": 255,
- "name": "startport",
- "required": true,
- "type": "integer"
+ "name": "cidrlist",
+ "required": false,
+ "type": "list"
},
{
"description": "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",
@@ -20692,30 +20678,42 @@
"name": "openfirewall",
"required": false,
"type": "boolean"
+ },
+ {
+ "description": "the start port for the rule",
+ "length": 255,
+ "name": "startport",
+ "required": true,
+ "type": "integer"
+ },
+ {
+ "description": "the end port for the rule",
+ "length": 255,
+ "name": "endport",
+ "required": false,
+ "type": "integer"
}
],
"related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules",
"response": [
- {},
- {},
{
- "description": "is firewall for display to the regular user",
- "name": "fordisplay",
- "type": "boolean"
- },
- {
- "description": "the VM display name for the port forwarding rule",
- "name": "virtualmachinedisplayname",
+ "description": "the 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",
+ "description": "the starting port of port forwarding rule's private port range",
+ "name": "privateport",
"type": "string"
},
{
- "description": "the starting port of port forwarding rule's public port range",
- "name": "publicport",
+ "description": "the VM name for the port forwarding rule",
+ "name": "virtualmachinename",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the port forwarding rule",
+ "name": "id",
"type": "string"
},
{
@@ -20724,14 +20722,14 @@
"type": "string"
},
{
- "description": "the protocol of the port forwarding rule",
- "name": "protocol",
+ "description": "the ending port of port forwarding rule's private port range",
+ "name": "publicendport",
"type": "string"
},
{
- "description": "the vm ip address for the port forwarding rule",
- "name": "vmguestip",
- "type": "string"
+ "description": "is firewall for display to the regular user",
+ "name": "fordisplay",
+ "type": "boolean"
},
{
"description": "the current status of the latest async job acting on this object",
@@ -20739,37 +20737,37 @@
"type": "integer"
},
{
- "description": "the ID of the port forwarding rule",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).",
- "name": "cidrlist",
- "type": "string"
- },
- {
- "description": "the public ip address id for the port forwarding rule",
- "name": "ipaddressid",
- "type": "string"
- },
- {
- "description": "the VM ID for the port forwarding rule",
- "name": "virtualmachineid",
- "type": "string"
- },
- {
- "description": "the id of the guest network the port forwarding rule belongs to",
- "name": "networkid",
- "type": "string"
- },
- {
"description": "the list of resource tags associated with the rule",
"name": "tags",
"response": [
{
- "description": "id of the resource",
- "name": "resourceid",
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "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"
},
{
@@ -20783,56 +20781,41 @@
"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 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",
"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 private port range",
- "name": "privateport",
+ "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 VM display name for the port forwarding rule",
+ "name": "virtualmachinedisplayname",
"type": "string"
},
{
- "description": "the VM name for the port forwarding rule",
- "name": "virtualmachinename",
+ "description": "the VM ID for the port forwarding rule",
+ "name": "virtualmachineid",
+ "type": "string"
+ },
+ {
+ "description": "the public ip address id for the port forwarding rule",
+ "name": "ipaddressid",
+ "type": "string"
+ },
+ {
+ "description": "the protocol of the port forwarding rule",
+ "name": "protocol",
"type": "string"
},
{
@@ -20841,8 +20824,25 @@
"type": "string"
},
{
+ "description": "the starting port of port forwarding rule's public port range",
+ "name": "publicport",
+ "type": "string"
+ },
+ {
+ "description": "the vm ip address for the port forwarding rule",
+ "name": "vmguestip",
+ "type": "string"
+ },
+ {},
+ {},
+ {
+ "description": "the id of the guest network the port forwarding rule belongs to",
+ "name": "networkid",
+ "type": "string"
+ },
+ {
"description": "the ending port of port forwarding rule's private port range",
- "name": "publicendport",
+ "name": "privateendport",
"type": "string"
}
]
@@ -20853,12 +20853,11 @@
"name": "listVolumesMetrics",
"params": [
{
- "description": "the ID of the disk volume",
+ "description": "List resources by tags (key/value pairs)",
"length": 255,
- "name": "id",
- "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume",
+ "name": "tags",
"required": false,
- "type": "uuid"
+ "type": "map"
},
{
"description": "list resources by account. Must be used with the domainId parameter.",
@@ -20868,20 +20867,34 @@
"type": "string"
},
{
- "description": "the ID of the storage pool, available to ROOT admin only",
+ "description": "List by keyword",
"length": 255,
- "name": "storageid",
- "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities",
+ "name": "keyword",
"required": false,
- "since": "4.3",
"type": "string"
},
{
- "description": "the type of disk volume",
+ "description": "list only resources belonging to the domain specified",
"length": 255,
- "name": "type",
+ "name": "domainid",
+ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
"required": false,
- "type": "string"
+ "type": "uuid"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "the ID of the disk volume",
+ "length": 255,
+ "name": "id",
+ "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume",
+ "required": false,
+ "type": "uuid"
},
{
"description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.",
@@ -20891,16 +20904,40 @@
"type": "string"
},
{
- "description": "the name of the disk volume",
+ "description": "list objects by project",
"length": 255,
- "name": "name",
+ "name": "projectid",
+ "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject",
"required": false,
- "type": "string"
+ "type": "uuid"
+ },
+ {
+ "description": "the cluster id the disk volume belongs to",
+ "length": 255,
+ "name": "clusterid",
+ "related": "addCluster,updateCluster",
+ "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",
+ "length": 255,
+ "name": "listall",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "the ID of the availability zone",
+ "length": 255,
+ "name": "zoneid",
+ "related": "createZone,updateZone,listZones,listZones",
+ "required": false,
+ "type": "uuid"
},
{
"description": "",
"length": 255,
- "name": "pagesize",
+ "name": "page",
"required": false,
"type": "integer"
},
@@ -20914,59 +20951,6 @@
"type": "uuid"
},
{
- "description": "the ID of the virtual machine",
- "length": 255,
- "name": "virtualmachineid",
- "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
- "length": 255,
- "name": "isrecursive",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "",
- "length": 255,
- "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",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "list objects by project",
- "length": 255,
- "name": "projectid",
- "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "list volumes on specified host",
- "length": 255,
- "name": "hostid",
- "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost,listExternalLoadBalancers",
- "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",
- "length": 255,
- "name": "listall",
- "required": false,
- "type": "boolean"
- },
- {
"description": "list resources by display flag; only ROOT admin is eligible to pass this parameter",
"length": 255,
"name": "displayvolume",
@@ -20975,6 +20959,22 @@
"type": "boolean"
},
{
+ "description": "the ID of the storage pool, available to ROOT admin only",
+ "length": 255,
+ "name": "storageid",
+ "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities",
+ "required": false,
+ "since": "4.3",
+ "type": "string"
+ },
+ {
+ "description": "the name of the disk volume",
+ "length": 255,
+ "name": "name",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "the pod id the disk volume belongs to",
"length": 255,
"name": "podid",
@@ -20983,10 +20983,10 @@
"type": "uuid"
},
{
- "description": "the ID of the availability zone",
+ "description": "the ID of the virtual machine",
"length": 255,
- "name": "zoneid",
- "related": "createZone,updateZone,listZones,listZones",
+ "name": "virtualmachineid",
+ "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance",
"required": false,
"type": "uuid"
},
@@ -21000,265 +21000,53 @@
"type": "list"
},
{
- "description": "List by keyword",
+ "description": "list volumes on specified host",
"length": 255,
- "name": "keyword",
+ "name": "hostid",
+ "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost,listExternalLoadBalancers",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "the type of disk volume",
+ "length": 255,
+ "name": "type",
"required": false,
"type": "string"
},
{
- "description": "List resources by tags (key/value pairs)",
+ "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
"length": 255,
- "name": "tags",
+ "name": "isrecursive",
"required": false,
- "type": "map"
- },
- {
- "description": "the cluster id the disk volume belongs to",
- "length": 255,
- "name": "clusterid",
- "related": "addCluster,updateCluster",
- "required": false,
- "type": "uuid"
+ "type": "boolean"
}
],
"related": "",
"response": [
{
- "description": "id of the virtual machine",
- "name": "virtualmachineid",
+ "description": "the display text of the disk offering",
+ "name": "diskofferingdisplaytext",
"type": "string"
},
{
- "description": "the name of the ISO attached to the virtual machine",
- "name": "isoname",
- "type": "string"
- },
- {
- "description": "the 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": "provisioning type used to create volumes.",
- "name": "provisioningtype",
- "type": "string"
- },
- {
- "description": "name of the virtual machine",
- "name": "vmname",
- "type": "string"
- },
- {
- "description": "an alternate display text of the ISO attached to the virtual machine",
- "name": "isodisplaytext",
- "type": "string"
- },
- {
- "description": "the write (bytes) of disk on the vm",
- "name": "diskkbswrite",
- "type": "long"
- },
- {
"description": "the status of the volume",
"name": "status",
"type": "string"
},
{
- "description": "the total disk iops",
- "name": "diskiopstotal",
- "type": "long"
- },
- {},
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "max iops of the disk volume",
- "name": "maxiops",
- "type": "long"
- },
- {
- "description": "type of the disk volume (ROOT or DATADISK)",
- "name": "type",
- "type": "string"
- },
- {
- "description": "the date the volume was attached to a VM instance",
- "name": "attached",
- "type": "date"
- },
- {},
- {
- "description": "need quiesce vm or not when taking snapshot",
- "name": "quiescevm",
- "type": "boolean"
- },
- {
- "description": "bytes write rate of the disk volume",
- "name": "diskBytesWriteRate",
- "type": "long"
- },
- {
- "description": "the bytes actually consumed on disk",
- "name": "virtualsize",
- "type": "long"
- },
- {
- "description": "the read (bytes) of disk on the vm",
- "name": "diskkbsread",
- "type": "long"
- },
- {
- "description": "cluster name where the volume is allocated",
- "name": "clustername",
- "type": "string"
- },
- {
"description": "name of the disk volume",
"name": "name",
"type": "string"
},
{
- "description": "min iops of the disk volume",
- "name": "miniops",
- "type": "long"
- },
- {
- "description": "the name of the template for the virtual machine",
- "name": "templatename",
+ "description": "type of the disk volume (ROOT or DATADISK)",
+ "name": "type",
"type": "string"
},
{
- "description": "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",
- "type": "string"
- },
- {
- "description": "Hypervisor the volume belongs to",
- "name": "hypervisor",
- "type": "string"
- },
- {
- "description": "shared or local storage",
- "name": "storagetype",
- "type": "string"
- },
- {
- "description": "id of the primary storage hosting the disk volume; returned to admin user only",
- "name": "storageid",
- "type": "string"
- },
- {
- "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": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "cluster id of the volume",
- "name": "clusterid",
- "type": "string"
- },
- {
- "description": "the chain info of the volume",
- "name": "chaininfo",
- "type": "string"
- },
- {
- "description": "disk size in GiB",
- "name": "sizegb",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the disk volume",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the bytes allocated",
- "name": "physicalsize",
- "type": "long"
- },
- {
- "description": " an alternate display text of the template for the virtual machine",
- "name": "templatedisplaytext",
- "type": "string"
- },
- {
- "description": "the domain associated with the disk volume",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "pod id of the volume",
- "name": "podid",
- "type": "string"
- },
- {
- "description": "io requests read rate of the disk volume per the disk offering",
- "name": "diskIopsReadRate",
- "type": "long"
- },
- {
- "description": "ID of the disk offering",
- "name": "diskofferingid",
- "type": "string"
- },
- {
- "description": "name of the service offering for root disk",
- "name": "serviceofferingname",
- "type": "string"
- },
- {
- "description": "display name of the virtual machine",
- "name": "vmdisplayname",
- "type": "string"
- },
- {
- "description": "the account associated with the disk volume",
- "name": "account",
- "type": "string"
- },
- {
- "description": "size of the disk volume",
- "name": "size",
- "type": "long"
- },
- {
- "description": "the project id of the vpn",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the write (io) of disk on the vm",
- "name": "diskiowrite",
- "type": "long"
- },
- {
- "description": "an optional field whether to the display the volume to the end user or not.",
- "name": "displayvolume",
- "type": "boolean"
- },
- {
- "description": "state of the virtual machine",
- "name": "vmstate",
+ "description": "provisioning type used to create volumes.",
+ "name": "provisioningtype",
"type": "string"
},
{
@@ -21267,8 +21055,44 @@
"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": "ID of the snapshot from which this volume was created",
+ "name": "snapshotid",
+ "type": "string"
+ },
+ {
+ "description": "an optional field whether to the display the volume to the end user or not.",
+ "name": "displayvolume",
+ "type": "boolean"
+ },
+ {
+ "description": "need quiesce vm or not when taking snapshot",
+ "name": "quiescevm",
+ "type": "boolean"
+ },
+ {
+ "description": "id of the virtual machine",
+ "name": "virtualmachineid",
+ "type": "string"
+ },
+ {
+ "description": "ID of the availability zone",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "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",
+ "type": "string"
+ },
+ {
+ "description": "min iops of the disk volume",
+ "name": "miniops",
"type": "long"
},
{
@@ -21277,13 +21101,28 @@
"type": "string"
},
{
- "description": "the date the disk volume was created",
- "name": "created",
- "type": "date"
+ "description": "id of the primary storage hosting the disk volume; returned to admin user only",
+ "name": "storageid",
+ "type": "string"
},
{
- "description": "the path of the volume",
- "name": "path",
+ "description": "display name of the virtual machine",
+ "name": "vmdisplayname",
+ "type": "string"
+ },
+ {
+ "description": "the read (bytes) of disk on the vm",
+ "name": "diskkbsread",
+ "type": "long"
+ },
+ {
+ "description": "bytes read rate of the disk volume",
+ "name": "diskBytesReadRate",
+ "type": "long"
+ },
+ {
+ "description": "the account associated with the disk volume",
+ "name": "account",
"type": "string"
},
{
@@ -21292,77 +21131,57 @@
"type": "long"
},
{
- "description": "pod name of the volume",
- "name": "podname",
- "type": "string"
- },
- {
- "description": "name of the primary storage hosting the disk volume",
- "name": "storage",
- "type": "string"
- },
- {
- "description": "ID of the service offering for root disk",
- "name": "serviceofferingid",
- "type": "string"
- },
- {
- "description": "true if the volume is extractable, false otherwise",
- "name": "isextractable",
- "type": "boolean"
- },
- {
"description": "name of the disk offering",
"name": "diskofferingname",
"type": "string"
},
{
- "description": "the read (io) of disk on the vm",
- "name": "diskioread",
- "type": "long"
+ "description": "name of the virtual machine",
+ "name": "vmname",
+ "type": "string"
+ },
+ {
+ "description": "the path of the volume",
+ "name": "path",
+ "type": "string"
+ },
+ {
+ "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": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
"description": "id of the resource",
"name": "resourceid",
"type": "string"
},
{
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "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",
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
"type": "string"
},
{
@@ -21371,31 +21190,92 @@
"type": "string"
},
{
- "description": "resource type",
- "name": "resourcetype",
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
"type": "string"
}
],
"type": "set"
},
{
+ "description": "shared or local storage",
+ "name": "storagetype",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the bytes actually consumed on disk",
+ "name": "virtualsize",
+ "type": "long"
+ },
+ {
+ "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": "bytes read rate of the disk volume",
- "name": "diskBytesReadRate",
- "type": "long"
- },
- {
- "description": "ID of the availability zone",
- "name": "zoneid",
+ "description": "ID of the service offering for root disk",
+ "name": "serviceofferingid",
"type": "string"
},
{
- "description": "the ID of the ISO attached to the virtual machine",
- "name": "isoid",
+ "description": "the disk utilization",
+ "name": "utilization",
+ "type": "string"
+ },
+ {
+ "description": "the project id of the vpn",
+ "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",
+ "type": "string"
+ },
+ {
+ "description": "Hypervisor the volume belongs to",
+ "name": "hypervisor",
+ "type": "string"
+ },
+ {
+ "description": "true if the volume is extractable, false otherwise",
+ "name": "isextractable",
+ "type": "boolean"
+ },
+ {
+ "description": "the boolean state of whether the volume is destroyed or not",
+ "name": "destroyed",
+ "type": "boolean"
+ },
+ {
+ "description": "the date the volume was attached to a VM instance",
+ "name": "attached",
+ "type": "date"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "disk size in GiB",
+ "name": "sizegb",
"type": "string"
},
{
@@ -21404,8 +21284,23 @@
"type": "string"
},
{
- "description": "name of the availability zone",
- "name": "zonename",
+ "description": "pod name of the volume",
+ "name": "podname",
+ "type": "string"
+ },
+ {
+ "description": "the total disk iops",
+ "name": "diskiopstotal",
+ "type": "long"
+ },
+ {
+ "description": "the ID of the domain associated with the disk volume",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "name of the primary storage hosting the disk volume",
+ "name": "storage",
"type": "string"
},
{
@@ -21414,9 +21309,114 @@
"type": "string"
},
{
- "description": "ID of the snapshot from which this volume was created",
- "name": "snapshotid",
+ "description": "io requests read rate of the disk volume per the disk offering",
+ "name": "diskIopsReadRate",
+ "type": "long"
+ },
+ {
+ "description": "bytes write rate of the disk volume",
+ "name": "diskBytesWriteRate",
+ "type": "long"
+ },
+ {
+ "description": "pod id of the volume",
+ "name": "podid",
"type": "string"
+ },
+ {
+ "description": "the domain associated with the disk volume",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the name of the ISO attached to the virtual machine",
+ "name": "isoname",
+ "type": "string"
+ },
+ {
+ "description": "the bytes allocated",
+ "name": "physicalsize",
+ "type": "long"
+ },
+ {
+ "description": "the chain info of the volume",
+ "name": "chaininfo",
+ "type": "string"
+ },
+ {
+ "description": "cluster name where the volume is allocated",
+ "name": "clustername",
+ "type": "string"
+ },
+ {
+ "description": "name of the availability zone",
+ "name": "zonename",
+ "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 write (bytes) of disk on the vm",
+ "name": "diskkbswrite",
+ "type": "long"
+ },
+ {
+ "description": "name of the service offering for root disk",
+ "name": "serviceofferingname",
+ "type": "string"
+ },
+ {
+ "description": " an alternate display text of the template for the virtual machine",
+ "name": "templatedisplaytext",
+ "type": "string"
+ },
+ {
+ "description": "ID of the disk offering",
+ "name": "diskofferingid",
+ "type": "string"
+ },
+ {
+ "description": "cluster id of the volume",
+ "name": "clusterid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the ISO attached to the virtual machine",
+ "name": "isoid",
+ "type": "string"
+ },
+ {
+ "description": "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 read (io) of disk on the vm",
+ "name": "diskioread",
+ "type": "long"
+ },
+ {
+ "description": "the write (io) of disk on the vm",
+ "name": "diskiowrite",
+ "type": "long"
+ },
+ {
+ "description": "size of the disk volume",
+ "name": "size",
+ "type": "long"
+ },
+ {
+ "description": "max iops of the disk volume",
+ "name": "maxiops",
+ "type": "long"
}
],
"since": "4.9.3"
@@ -21436,36 +21436,36 @@
],
"related": "listElastistorVolume",
"response": [
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
{},
{
"description": "syncronization",
"name": "sync",
"type": "string"
},
- {},
{
- "description": "deduplication",
- "name": "deduplication",
+ "description": "the name of the volume",
+ "name": "name",
"type": "string"
},
+ {},
{
"description": "compression",
"name": "compression",
"type": "string"
},
{
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
"description": "graceallowed",
"name": "graceallowed",
"type": "string"
},
{
- "description": "the id of the volume",
- "name": "id",
+ "description": "deduplication",
+ "name": "deduplication",
"type": "string"
},
{
@@ -21474,8 +21474,8 @@
"type": "integer"
},
{
- "description": "the name of the volume",
- "name": "name",
+ "description": "the id of the volume",
+ "name": "id",
"type": "string"
}
]
@@ -21486,23 +21486,27 @@
"name": "listDetailOptions",
"params": [
{
- "description": "the resource type such as UserVm, Template etc.",
- "length": 255,
- "name": "resourcetype",
- "required": true,
- "type": "string"
- },
- {
"description": "the UUID of the resource (optional)",
"length": 255,
"name": "resourceid",
"required": false,
"type": "string"
+ },
+ {
+ "description": "the resource type such as UserVm, Template etc.",
+ "length": 255,
+ "name": "resourcetype",
+ "required": true,
+ "type": "string"
}
],
"related": "",
"response": [
- {},
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
{
"description": "Map of all possible details and their possible list of values",
"name": "details",
@@ -21514,11 +21518,7 @@
"type": "integer"
},
{},
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- }
+ {}
],
"since": "4.13"
},
@@ -21528,6 +21528,14 @@
"name": "listSslCerts",
"params": [
{
+ "description": "ID of SSL certificate",
+ "length": 255,
+ "name": "certid",
+ "related": "uploadSslCert,listSslCerts",
+ "required": false,
+ "type": "uuid"
+ },
+ {
"description": "Load balancer rule ID",
"length": 255,
"name": "lbruleid",
@@ -21550,14 +21558,6 @@
"related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject",
"required": false,
"type": "uuid"
- },
- {
- "description": "ID of SSL certificate",
- "length": 255,
- "name": "certid",
- "related": "uploadSslCert,listSslCerts",
- "required": false,
- "type": "uuid"
}
],
"related": "uploadSslCert",
@@ -21568,8 +21568,13 @@
"type": "list"
},
{
- "description": "SSL certificate ID",
- "name": "id",
+ "description": "name",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the project id of the certificate",
+ "name": "projectid",
"type": "string"
},
{
@@ -21578,18 +21583,8 @@
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the project id of the certificate",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "certificate fingerprint",
- "name": "fingerprint",
+ "description": "account for the certificate",
+ "name": "account",
"type": "string"
},
{
@@ -21597,6 +21592,23 @@
"name": "project",
"type": "string"
},
+ {},
+ {
+ "description": "certificate chain",
+ "name": "certchain",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "certificate fingerprint",
+ "name": "fingerprint",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
{
"description": "certificate",
"name": "certificate",
@@ -21607,27 +21619,15 @@
"name": "jobid",
"type": "string"
},
- {},
{
- "description": "name",
- "name": "name",
- "type": "string"
- },
- {
- "description": "account for the certificate",
- "name": "account",
+ "description": "SSL certificate ID",
+ "name": "id",
"type": "string"
},
{
"description": "the domain name of the network owner",
"name": "domain",
"type": "string"
- },
- {},
- {
- "description": "certificate chain",
- "name": "certchain",
- "type": "string"
}
]
},
@@ -21637,28 +21637,6 @@
"name": "listPrivateGateways",
"params": [
{
- "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",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "",
- "length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
- },
- {
"description": "list gateways by state",
"length": 255,
"name": "state",
@@ -21673,19 +21651,19 @@
"type": "string"
},
{
- "description": "list gateways by vpc",
+ "description": "list objects by project",
"length": 255,
- "name": "vpcid",
- "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC",
+ "name": "projectid",
+ "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject",
"required": false,
"type": "uuid"
},
{
- "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
+ "description": "",
"length": 255,
- "name": "isrecursive",
+ "name": "pagesize",
"required": false,
- "type": "boolean"
+ "type": "integer"
},
{
"description": "List by keyword",
@@ -21695,10 +21673,31 @@
"type": "string"
},
{
- "description": "list objects by project",
+ "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": "string"
+ },
+ {
+ "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
+ "length": 255,
+ "name": "isrecursive",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "list gateways by ip address",
+ "length": 255,
+ "name": "ipaddress",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "list private gateway by id",
+ "length": 255,
+ "name": "id",
+ "related": "createPrivateGateway,listPrivateGateways",
"required": false,
"type": "uuid"
},
@@ -21710,114 +21709,40 @@
"type": "boolean"
},
{
- "description": "list private gateway by id",
+ "description": "list only resources belonging to the domain specified",
"length": 255,
- "name": "id",
- "related": "createPrivateGateway,listPrivateGateways",
+ "name": "domainid",
+ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
"required": false,
"type": "uuid"
},
{
- "description": "list gateways by ip address",
+ "description": "list gateways by vpc",
"length": 255,
- "name": "ipaddress",
+ "name": "vpcid",
+ "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC",
"required": false,
- "type": "string"
+ "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"
}
],
"related": "createPrivateGateway",
"response": [
{
- "description": "State of the gateway, can be Creating, Ready, Deleting",
- "name": "state",
- "type": "string"
- },
- {
- "description": "the private gateway's netmask",
- "name": "netmask",
- "type": "string"
- },
- {
- "description": "the private gateway's ip address",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "description": "the network implementation uri for the private gateway",
- "name": "vlan",
- "type": "string"
- },
- {
- "description": "the id of the private gateway",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the name of the zone the private gateway belongs to",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "VPC id the private gateway belongs to",
- "name": "vpcid",
- "type": "string"
- },
- {
- "description": "the project id of the private gateway",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the gateway",
- "name": "gateway",
- "type": "string"
- },
- {
- "description": "Souce Nat enable status",
- "name": "sourcenatsupported",
- "type": "boolean"
- },
- {
- "description": "the account associated with the private gateway",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the project name of the private gateway",
- "name": "project",
- "type": "string"
- },
- {
- "description": "VPC name the private gateway belongs to",
- "name": "vpcname",
+ "description": "zone id of the private gateway",
+ "name": "zoneid",
"type": "string"
},
{},
{
- "description": "ACL Id set for private gateway",
- "name": "aclid",
- "type": "string"
- },
- {
- "description": "ACL name set for private gateway",
- "name": "aclname",
- "type": "string"
- },
- {
- "description": "the physical network id",
- "name": "physicalnetworkid",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the account associated with the private gateway",
+ "name": "account",
"type": "string"
},
{
@@ -21831,8 +21756,64 @@
"type": "integer"
},
{
- "description": "zone id of the private gateway",
- "name": "zoneid",
+ "description": "VPC id the private gateway belongs to",
+ "name": "vpcid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the project name of the private gateway",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the physical network id",
+ "name": "physicalnetworkid",
+ "type": "string"
+ },
+ {
+ "description": "ACL Id set for private gateway",
+ "name": "aclid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the zone the private gateway belongs to",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "State of the gateway, can be Creating, Ready, Deleting",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "Souce Nat enable status",
+ "name": "sourcenatsupported",
+ "type": "boolean"
+ },
+ {
+ "description": "the gateway",
+ "name": "gateway",
+ "type": "string"
+ },
+ {
+ "description": "VPC name the private gateway belongs to",
+ "name": "vpcname",
+ "type": "string"
+ },
+ {
+ "description": "the private gateway's ip address",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "the network implementation uri for the private gateway",
+ "name": "vlan",
+ "type": "string"
+ },
+ {
+ "description": "the private gateway's netmask",
+ "name": "netmask",
"type": "string"
},
{
@@ -21840,7 +21821,26 @@
"name": "domainid",
"type": "string"
},
- {}
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the id of the private gateway",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "ACL name set for private gateway",
+ "name": "aclname",
+ "type": "string"
+ },
+ {
+ "description": "the project id of the private gateway",
+ "name": "projectid",
+ "type": "string"
+ }
]
},
{
@@ -21849,31 +21849,541 @@
"name": "updateVmNicIp",
"params": [
{
+ "description": "Secondary IP Address",
+ "length": 255,
+ "name": "ipaddress",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "the ID of the nic to which you want to assign private IP",
"length": 255,
"name": "nicid",
"related": "listNics",
"required": true,
"type": "uuid"
- },
- {
- "description": "Secondary IP Address",
- "length": 255,
- "name": "ipaddress",
- "required": false,
- "type": "string"
}
],
"related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance",
"response": [
{
- "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": "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 project id of the vm",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.",
+ "name": "isdynamicallyscalable",
+ "type": "boolean"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "ssh key-pair",
+ "name": "keypair",
+ "type": "string"
+ },
+ {
+ "description": "List of read-only Vm details as comma separated string.",
+ "name": "readonlydetails",
+ "type": "string"
+ },
+ {
+ "description": "list of security groups associated with the virtual machine",
+ "name": "securitygroup",
+ "response": [
+ {
+ "description": "the project name of the group",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the list of egress rules associated with the security group",
+ "name": "egressrule",
+ "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": "security group name",
+ "name": "securitygroupname",
+ "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 ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "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 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 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 code for the ICMP message response",
+ "name": "icmpcode",
+ "type": "integer"
+ },
+ {
+ "description": "the starting IP of the security group rule",
+ "name": "startport",
+ "type": "integer"
+ },
+ {
+ "description": "account owning the security group rule",
+ "name": "account",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the list of 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 id of the group",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the number of virtualmachines associated with this securitygroup",
+ "name": "virtualmachinecount",
+ "type": "integer"
+ },
+ {
+ "description": "the domain ID of the security group",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the 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 CIDR notation for the base IP address of the security group rule",
+ "name": "cidr",
+ "type": "string"
+ },
+ {
+ "description": "the id of the security group rule",
+ "name": "ruleid",
+ "type": "string"
+ },
+ {
+ "description": "security group name",
+ "name": "securitygroupname",
+ "type": "string"
+ },
+ {
+ "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",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the code for the ICMP message response",
+ "name": "icmpcode",
+ "type": "integer"
+ },
+ {
+ "description": "the protocol of the security group rule",
+ "name": "protocol",
+ "type": "string"
+ },
+ {
+ "description": "the type of the ICMP message response",
+ "name": "icmptype",
+ "type": "integer"
+ },
+ {
+ "description": "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 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": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "tag 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": "tag value",
+ "name": "value",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the account owning the security group",
+ "name": "account",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "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",
+ "type": "string"
+ },
+ {
+ "description": "the number of cpu this virtual machine is running with",
+ "name": "cpunumber",
+ "type": "integer"
+ },
+ {
+ "description": "Guest vm Boot Type",
+ "name": "boottype",
+ "type": "string"
+ },
+ {
+ "description": "the name of the domain in which the virtual machine exists",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the write (io) of disk on the vm",
+ "name": "diskiowrite",
+ "type": "long"
+ },
+ {
+ "description": "the read (bytes) of disk on the vm",
+ "name": "diskkbsread",
+ "type": "long"
+ },
+ {
+ "description": "an alternate display text of the ISO attached to the virtual machine",
+ "name": "isodisplaytext",
+ "type": "string"
+ },
+ {
+ "description": "OS name of the vm",
+ "name": "osdisplayname",
+ "type": "string"
+ },
+ {
+ "description": "device type of the root volume",
+ "name": "rootdevicetype",
+ "type": "string"
+ },
+ {
+ "description": "the memory allocated for the virtual machine",
+ "name": "memory",
+ "type": "integer"
+ },
+ {
+ "description": "the password (if exists) of the virtual machine",
+ "name": "password",
+ "type": "string"
+ },
+ {
+ "description": "the list of resource tags associated",
+ "name": "tags",
+ "response": [
+ {
+ "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 name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "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"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": " an alternate display text of the template for the virtual machine",
+ "name": "templatedisplaytext",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the vm's CPU currently used",
+ "name": "cpuused",
+ "type": "string"
+ },
+ {
+ "description": "the pool type of the virtual machine",
+ "name": "pooltype",
+ "type": "string"
+ },
+ {
+ "description": "the name of the ISO attached to the virtual machine",
+ "name": "isoname",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the availablility zone for the virtual machine",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the group name of the virtual machine",
+ "name": "group",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the disk offering of the virtual machine",
+ "name": "diskofferingid",
"type": "string"
},
{
@@ -21881,16 +22391,6 @@
"name": "affinitygroup",
"response": [
{
- "description": "the name of the affinity group",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the project ID of the affinity group",
- "name": "projectid",
- "type": "string"
- },
- {
"description": "the description of the affinity group",
"name": "description",
"type": "string"
@@ -21906,18 +22406,8 @@
"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 domain ID of the affinity group",
- "name": "domainid",
+ "description": "the name of the affinity group",
+ "name": "name",
"type": "string"
},
{
@@ -21929,79 +22419,119 @@
"description": "the domain name of the affinity group",
"name": "domain",
"type": "string"
+ },
+ {
+ "description": "the ID of the affinity group",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the project ID of the affinity group",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "virtual machine IDs associated with this affinity group",
+ "name": "virtualmachineIds",
+ "type": "list"
+ },
+ {
+ "description": "the domain ID of the affinity group",
+ "name": "domainid",
+ "type": "string"
}
],
"type": "set"
},
+ {
+ "description": "the name of the virtual machine",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the speed of each cpu",
+ "name": "cpuspeed",
+ "type": "integer"
+ },
{},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the ID of the domain in which the virtual machine exists",
+ "name": "domainid",
"type": "string"
},
{
- "description": "the ID of the backup offering of the virtual machine",
- "name": "backupofferingid",
- "type": "string"
- },
- {
- "description": "the pool type of the virtual machine",
- "name": "pooltype",
- "type": "string"
- },
- {
- "description": "the ID of the availablility zone for the virtual machine",
- "name": "zoneid",
- "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": "Vm details in key/value pairs.",
- "name": "details",
- "type": "map"
- },
- {
- "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.",
- "name": "isdynamicallyscalable",
+ "description": "true if high-availability is enabled, false otherwise",
+ "name": "haenable",
"type": "boolean"
},
{
- "description": "the read (bytes) of disk on the vm",
- "name": "diskkbsread",
+ "description": "the vgpu type used by the virtual machine",
+ "name": "vgpu",
+ "type": "string"
+ },
+ {
+ "description": "the memory used by the vm",
+ "name": "memorykbs",
"type": "long"
},
{
- "description": "the target memory in vm",
- "name": "memorytargetkbs",
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "description": "the state of the virtual machine",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "the read (io) of disk on the vm",
+ "name": "diskioread",
"type": "long"
},
{
- "description": "the ID of the disk offering of the virtual machine",
- "name": "diskofferingid",
+ "description": "Os type ID of the virtual machine",
+ "name": "guestosid",
"type": "string"
},
{
- "description": "List of read-only Vm details as comma separated string.",
- "name": "readonlydetails",
+ "description": "the incoming network traffic on the vm",
+ "name": "networkkbsread",
+ "type": "long"
+ },
+ {
+ "description": "the name of the service offering of the virtual machine",
+ "name": "serviceofferingname",
"type": "string"
},
{
- "description": "the user's name who deployed the virtual machine",
- "name": "username",
+ "description": "the total number of network traffic bytes received",
+ "name": "receivedbytes",
+ "type": "long"
+ },
+ {
+ "description": "the ID of the service offering of the virtual machine",
+ "name": "serviceofferingid",
"type": "string"
},
{
- "description": "the name of the host for the virtual machine",
- "name": "hostname",
+ "description": "the user's ID who deployed the virtual machine",
+ "name": "userid",
+ "type": "string"
+ },
+ {
+ "description": "the hypervisor on which the template runs",
+ "name": "hypervisor",
+ "type": "string"
+ },
+ {
+ "description": "the name of the disk offering of the virtual machine",
+ "name": "diskofferingname",
+ "type": "string"
+ },
+ {
+ "description": "the group ID of the virtual machine",
+ "name": "groupid",
"type": "string"
},
{
@@ -22010,100 +22540,49 @@
"type": "string"
},
{
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
- },
- {
- "description": "the list of resource tags associated",
- "name": "tags",
- "response": [
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "the 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": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the ID of the virtual machine",
- "name": "id",
- "type": "string"
- },
- {
- "description": "OS name of the vm",
- "name": "osdisplayname",
- "type": "string"
- },
- {
- "description": "ssh key-pair",
- "name": "keypair",
- "type": "string"
- },
- {
"description": "the virtual network for the service offering",
"name": "forvirtualnetwork",
"type": "boolean"
},
{
- "description": "the ID of the host for the virtual machine",
- "name": "hostid",
+ "description": "an optional field whether to the display the vm to the end user or not.",
+ "name": "displayvm",
+ "type": "boolean"
+ },
+ {
+ "description": "the name of the availability zone for the virtual machine",
+ "name": "zonename",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "State of the Service from LB rule",
+ "name": "servicestate",
"type": "string"
},
{
- "description": "the name of the template for the virtual machine",
- "name": "templatename",
+ "description": "device ID of the root volume",
+ "name": "rootdeviceid",
+ "type": "long"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the account associated with the virtual machine",
+ "name": "account",
"type": "string"
},
{
- "description": "the 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 date when this virtual machine was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "public IP address id associated with vm via Static nat rule",
+ "name": "publicipid",
"type": "string"
},
{
@@ -22111,23 +22590,43 @@
"name": "nic",
"response": [
{
- "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": "ID of the VLAN/VNI if available",
- "name": "vlanid",
- "type": "integer"
+ "description": "the isolation uri of the nic",
+ "name": "isolationuri",
+ "type": "string"
},
{
- "description": "the type of the nic",
- "name": "type",
+ "description": "the ID of the nic",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the isolated private VLAN type if available",
+ "name": "isolatedpvlantype",
+ "type": "string"
+ },
+ {
+ "description": "the name of the corresponding network",
+ "name": "networkname",
+ "type": "string"
+ },
+ {
+ "description": "device id for the network when plugged into the virtual machine",
+ "name": "deviceid",
+ "type": "string"
+ },
+ {
+ "description": "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"
},
{
@@ -22136,8 +22635,23 @@
"type": "string"
},
{
- "description": "the gateway of IPv6 network",
- "name": "ip6gateway",
+ "description": "the ip address of the nic",
+ "name": "ipaddress",
+ "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"
},
{
@@ -22151,11 +22665,51 @@
"type": "integer"
},
{
- "description": "the isolation uri of the nic",
- "name": "isolationuri",
+ "description": "the gateway of the nic",
+ "name": "gateway",
"type": "string"
},
{
+ "description": "the Secondary ipv4 addr of nic",
+ "name": "secondaryip",
+ "type": "list"
+ },
+ {
+ "description": "the broadcast uri of the nic",
+ "name": "broadcasturi",
+ "type": "string"
+ },
+ {
+ "description": "true if nic is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {
+ "description": "the ID of the corresponding network",
+ "name": "networkid",
+ "type": "string"
+ },
+ {
+ "description": "the gateway of IPv6 network",
+ "name": "ip6gateway",
+ "type": "string"
+ },
+ {
+ "description": "the cidr of IPv6 network",
+ "name": "ip6cidr",
+ "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 extra dhcp options on the nic",
"name": "extradhcpoption",
"type": "list"
@@ -22164,616 +22718,13 @@
"description": "Type of adapter if available",
"name": "adaptertype",
"type": "string"
- },
- {
- "description": "true if nic is default, false otherwise",
- "name": "macaddress",
- "type": "string"
- },
- {
- "description": "the isolated private VLAN type if available",
- "name": "isolatedpvlantype",
- "type": "string"
- },
- {
- "description": "the IPv6 address of network",
- "name": "ip6address",
- "type": "string"
- },
- {
- "description": "the Secondary ipv4 addr of nic",
- "name": "secondaryip",
- "type": "list"
- },
- {
- "description": "the cidr of IPv6 network",
- "name": "ip6cidr",
- "type": "string"
- },
- {
- "description": "the ID of the corresponding network",
- "name": "networkid",
- "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 traffic type of the nic",
- "name": "traffictype",
- "type": "string"
- },
- {
- "description": "the gateway of the nic",
- "name": "gateway",
- "type": "string"
- },
- {
- "description": "the ip address of the nic",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "description": "the broadcast uri of the nic",
- "name": "broadcasturi",
- "type": "string"
- },
- {
- "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise",
- "name": "nsxlogicalswitchport",
- "type": "string"
- },
- {
- "description": "the name of the corresponding network",
- "name": "networkname",
- "type": "string"
- },
- {
- "description": "device id for the network when plugged into the virtual machine",
- "name": "deviceid",
- "type": "string"
}
],
"type": "set"
},
{
- "description": "device ID of the root volume",
- "name": "rootdeviceid",
- "type": "long"
- },
- {
- "description": "the hypervisor on which the template runs",
- "name": "hypervisor",
- "type": "string"
- },
- {
- "description": "the ID of the domain in which the virtual machine exists",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "Guest vm Boot Type",
- "name": "boottype",
- "type": "string"
- },
- {
- "description": "the name of the service offering of the virtual machine",
- "name": "serviceofferingname",
- "type": "string"
- },
- {},
- {
- "description": "the project id of the vm",
- "name": "projectid",
- "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 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 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": "security group name",
- "name": "securitygroupname",
- "type": "string"
- },
- {
- "description": "the protocol of the security group rule",
- "name": "protocol",
- "type": "string"
- },
- {
- "description": "the id of the security group rule",
- "name": "ruleid",
- "type": "string"
- },
- {
- "description": "the type of the ICMP message response",
- "name": "icmptype",
- "type": "integer"
- },
- {
- "description": "the code for the ICMP message response",
- "name": "icmpcode",
- "type": "integer"
- },
- {
- "description": "the starting IP of the security group rule",
- "name": "startport",
- "type": "integer"
- },
- {
- "description": "the list of resource tags associated with the rule",
- "name": "tags",
- "response": [
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "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": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- }
- ],
- "type": "set"
- }
- ],
- "type": "set"
- },
- {
- "description": "the list of resource tags associated with the rule",
- "name": "tags",
- "response": [
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "the 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"
- }
- ],
- "type": "set"
- },
- {
- "description": "the number of virtualmachines associated with this securitygroup",
- "name": "virtualmachinecount",
- "type": "integer"
- },
- {
- "description": "the project id of the group",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the list of ingress rules associated with the security group",
- "name": "ingressrule",
- "response": [
- {
- "description": "the id of the security group rule",
- "name": "ruleid",
- "type": "string"
- },
- {
- "description": "account owning the security group rule",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the CIDR notation for the base IP address of the security group rule",
- "name": "cidr",
- "type": "string"
- },
- {
- "description": "the type of the ICMP message response",
- "name": "icmptype",
- "type": "integer"
- },
- {
- "description": "the starting IP of the security group rule",
- "name": "startport",
- "type": "integer"
- },
- {
- "description": "the 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 code for the ICMP message response",
- "name": "icmpcode",
- "type": "integer"
- },
- {
- "description": "security group name",
- "name": "securitygroupname",
- "type": "string"
- },
- {
- "description": "the list of resource tags associated with the rule",
- "name": "tags",
- "response": [
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "the 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": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- }
- ],
- "type": "set"
- }
- ],
- "type": "set"
- },
- {
- "description": "the description of the security group",
- "name": "description",
- "type": "string"
- },
- {
- "description": "the ID of the security group",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the list of virtualmachine ids associated with this securitygroup",
- "name": "virtualmachineids",
- "type": "set"
- },
- {
- "description": "the name of the security group",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the account owning the security group",
- "name": "account",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "Os type ID of the virtual machine",
- "name": "guestosid",
- "type": "string"
- },
- {
- "description": "the number of cpu this virtual machine is running with",
- "name": "cpunumber",
- "type": "integer"
- },
- {
- "description": "the account associated with the virtual machine",
- "name": "account",
- "type": "string"
- },
- {
- "description": "public IP address id associated with vm via Static nat rule",
- "name": "publicipid",
- "type": "string"
- },
- {
- "description": "the state of the virtual machine",
- "name": "state",
- "type": "string"
- },
- {
- "description": "the total number of network traffic bytes sent",
- "name": "sentbytes",
- "type": "long"
- },
- {
- "description": "the write (bytes) of disk on the vm",
- "name": "diskkbswrite",
- "type": "long"
- },
- {
- "description": "the memory used by the vm",
- "name": "memorykbs",
- "type": "long"
- },
- {
- "description": "device type of the root volume",
- "name": "rootdevicetype",
- "type": "string"
- },
- {
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "the date when this virtual machine was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the group name of the virtual machine",
- "name": "group",
- "type": "string"
- },
- {
- "description": "an optional field whether to the display the vm to the end user or not.",
- "name": "displayvm",
- "type": "boolean"
- },
- {
- "description": "the write (io) of disk on the vm",
- "name": "diskiowrite",
- "type": "long"
- },
- {
- "description": "true if the password rest feature is enabled, false otherwise",
- "name": "passwordenabled",
- "type": "boolean"
- },
- {
- "description": "the user's ID who deployed the virtual machine",
- "name": "userid",
- "type": "string"
- },
- {
- "description": "the name of the virtual machine",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the name of the domain in which the virtual machine exists",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "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": "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 outgoing network traffic on the host",
- "name": "networkkbswrite",
- "type": "long"
- },
- {
- "description": "public IP address id associated with vm via Static nat rule",
- "name": "publicip",
- "type": "string"
- },
- {
- "description": "the internal memory that's free in vm or zero if it can not be calculated",
- "name": "memoryintfreekbs",
- "type": "long"
- },
- {
- "description": "the total number of network traffic bytes received",
- "name": "receivedbytes",
- "type": "long"
- },
- {
- "description": "the amount of the vm's CPU currently used",
- "name": "cpuused",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the read (io) of disk on the vm",
- "name": "diskioread",
- "type": "long"
- },
- {
- "description": "the name of the disk offering of the virtual machine",
- "name": "diskofferingname",
- "type": "string"
- },
- {
- "description": "the ID of the ISO attached to the virtual machine",
- "name": "isoid",
- "type": "string"
- },
- {
- "description": "the name of the availability zone for the virtual machine",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "the name of the backup offering of the virtual machine",
- "name": "backupofferingname",
- "type": "string"
- },
- {
- "description": "the group ID of the virtual machine",
- "name": "groupid",
+ "description": "the 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"
},
{
@@ -22782,24 +22733,28 @@
"type": "string"
},
{
- "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 incoming network traffic on the vm",
- "name": "networkkbsread",
+ "description": "the target memory in vm",
+ "name": "memorytargetkbs",
"type": "long"
},
{
- "description": " an alternate display text of the template for the virtual machine",
- "name": "templatedisplaytext",
+ "description": "the write (bytes) of disk on the vm",
+ "name": "diskkbswrite",
+ "type": "long"
+ },
+ {
+ "description": "Vm details in key/value pairs.",
+ "name": "details",
+ "type": "map"
+ },
+ {
+ "description": "the outgoing network traffic on the host",
+ "name": "networkkbswrite",
+ "type": "long"
+ },
+ {
+ "description": "the name of the backup offering of the virtual machine",
+ "name": "backupofferingname",
"type": "string"
},
{
@@ -22808,14 +22763,59 @@
"type": "string"
},
{
- "description": "State of the Service from LB rule",
- "name": "servicestate",
+ "description": "the internal memory that's free in vm or zero if it can not be calculated",
+ "name": "memoryintfreekbs",
+ "type": "long"
+ },
+ {
+ "description": "the name of the template for the virtual machine",
+ "name": "templatename",
"type": "string"
},
{
- "description": "the speed of each cpu",
- "name": "cpuspeed",
- "type": "integer"
+ "description": "true if the password rest feature is enabled, false otherwise",
+ "name": "passwordenabled",
+ "type": "boolean"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "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 host for the virtual machine",
+ "name": "hostid",
+ "type": "string"
+ },
+ {
+ "description": "the date when this virtual machine was updated last time",
+ "name": "lastupdated",
+ "type": "date"
+ },
+ {
+ "description": "the ID of the virtual machine",
+ "name": "id",
+ "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"
}
]
},
@@ -22825,14 +22825,6 @@
"name": "updateLBStickinessPolicy",
"params": [
{
- "description": "an optional field, whether to the display the policy to the end user or not",
- "length": 255,
- "name": "fordisplay",
- "required": false,
- "since": "4.4",
- "type": "boolean"
- },
- {
"description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only",
"length": 255,
"name": "customid",
@@ -22841,6 +22833,14 @@
"type": "string"
},
{
+ "description": "an optional field, whether to the display the policy to the end user or not",
+ "length": 255,
+ "name": "fordisplay",
+ "required": false,
+ "since": "4.4",
+ "type": "boolean"
+ },
+ {
"description": "id of lb stickiness policy",
"length": 255,
"name": "id",
@@ -22852,18 +22852,43 @@
"related": "createLBStickinessPolicy,listLBStickinessPolicies",
"response": [
{
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "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 list of stickinesspolicies",
"name": "stickinesspolicy",
"response": [
{
+ "description": "the name of the Stickiness policy",
+ "name": "name",
+ "type": "string"
+ },
+ {
"description": "the LB Stickiness policy ID",
"name": "id",
"type": "string"
},
{
- "description": "the params of the policy",
- "name": "params",
- "type": "map"
+ "description": "the state of the policy",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "the description of the Stickiness policy",
+ "name": "description",
+ "type": "string"
},
{
"description": "the method name of the Stickiness policy",
@@ -22876,34 +22901,31 @@
"type": "boolean"
},
{
- "description": "the description of the Stickiness policy",
- "name": "description",
- "type": "string"
- },
- {
- "description": "the name of the Stickiness policy",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the state of the policy",
- "name": "state",
- "type": "string"
+ "description": "the params of the policy",
+ "name": "params",
+ "type": "map"
}
],
"type": "list"
},
+ {},
{
- "description": "the domain of the Stickiness policy",
- "name": "domain",
+ "description": "the description of the Stickiness policy",
+ "name": "description",
"type": "string"
},
{
- "description": "the state of the policy",
- "name": "state",
+ "description": "the LB rule ID",
+ "name": "lbruleid",
"type": "string"
},
{
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {},
+ {
"description": "the id of the zone the Stickiness policy belongs to",
"name": "zoneid",
"type": "string"
@@ -22914,37 +22936,15 @@
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the name of the Stickiness policy",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the LB rule ID",
- "name": "lbruleid",
- "type": "string"
- },
- {
- "description": "the description of the Stickiness policy",
- "name": "description",
- "type": "string"
- },
- {
"description": "the account of the Stickiness policy",
"name": "account",
"type": "string"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the state of the policy",
+ "name": "state",
"type": "string"
- },
- {},
- {}
+ }
],
"since": "4.4"
},
@@ -22954,6 +22954,21 @@
"name": "listPods",
"params": [
{
+ "description": "list Pods by ID",
+ "length": 255,
+ "name": "id",
+ "related": "listPods,updatePod,createManagementNetworkIpRange",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "flag to display the capacity of the pods",
+ "length": 255,
+ "name": "showcapacities",
+ "required": false,
+ "type": "boolean"
+ },
+ {
"description": "List by keyword",
"length": 255,
"name": "keyword",
@@ -22961,10 +22976,17 @@
"type": "string"
},
{
- "description": "list Pods by ID",
+ "description": "list pods by allocation state",
"length": 255,
- "name": "id",
- "related": "listPods,updatePod,createManagementNetworkIpRange",
+ "name": "allocationstate",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "list Pods by Zone ID",
+ "length": 255,
+ "name": "zoneid",
+ "related": "createZone,updateZone,listZones,listZones",
"required": false,
"type": "uuid"
},
@@ -22976,18 +22998,11 @@
"type": "string"
},
{
- "description": "flag to display the capacity of the pods",
+ "description": "",
"length": 255,
- "name": "showcapacities",
+ "name": "page",
"required": false,
- "type": "boolean"
- },
- {
- "description": "list pods by allocation state",
- "length": 255,
- "name": "allocationstate",
- "required": false,
- "type": "string"
+ "type": "integer"
},
{
"description": "",
@@ -22995,68 +23010,15 @@
"name": "pagesize",
"required": false,
"type": "integer"
- },
- {
- "description": "list Pods by Zone ID",
- "length": 255,
- "name": "zoneid",
- "related": "createZone,updateZone,listZones,listZones",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "",
- "length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
}
],
"related": "updatePod,createManagementNetworkIpRange",
"response": [
{
- "description": "the IP ranges for the Pod",
- "name": "ipranges",
- "response": [
- {
- "description": "the starting IP for the range",
- "name": "startip",
- "type": "string"
- },
- {
- "description": "indicates Vlan ID for the range",
- "name": "vlanid",
- "type": "string"
- },
- {
- "description": "indicates if range is dedicated for CPVM and SSVM",
- "name": "forsystemvms",
- "type": "string"
- },
- {
- "description": "the ending IP for the range",
- "name": "endip",
- "type": "string"
- }
- ],
- "type": "list"
- },
- {
- "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.",
- "name": "vlanid",
- "type": "list"
- },
- {
- "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.",
- "name": "forsystemvms",
- "type": "list"
- },
- {
- "description": "the name of the Pod",
- "name": "name",
+ "description": "the allocation state of the Pod",
+ "name": "allocationstate",
"type": "string"
},
- {},
{
"description": "the capacity of the Pod",
"name": "capacity",
@@ -23067,6 +23029,16 @@
"type": "short"
},
{
+ "description": "the Cluster name",
+ "name": "clustername",
+ "type": "string"
+ },
+ {
+ "description": "the capacity name",
+ "name": "name",
+ "type": "string"
+ },
+ {
"description": "the capacity currently in allocated",
"name": "capacityallocated",
"type": "long"
@@ -23077,13 +23049,8 @@
"type": "long"
},
{
- "description": "the Cluster name",
- "name": "clustername",
- "type": "string"
- },
- {
- "description": "the capacity name",
- "name": "name",
+ "description": "the Pod ID",
+ "name": "podid",
"type": "string"
},
{
@@ -23097,8 +23064,8 @@
"type": "string"
},
{
- "description": "the Pod name",
- "name": "podname",
+ "description": "the Zone ID",
+ "name": "zoneid",
"type": "string"
},
{
@@ -23107,26 +23074,21 @@
"type": "string"
},
{
- "description": "the Pod ID",
- "name": "podid",
- "type": "string"
- },
- {
- "description": "the Zone ID",
- "name": "zoneid",
- "type": "string"
- },
- {
"description": "the Cluster ID",
"name": "clusterid",
"type": "string"
+ },
+ {
+ "description": "the Pod name",
+ "name": "podname",
+ "type": "string"
}
],
"type": "list"
},
{
- "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.",
- "name": "startip",
+ "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.",
+ "name": "vlanid",
"type": "list"
},
{
@@ -23139,34 +23101,25 @@
"name": "endip",
"type": "list"
},
+ {},
+ {
+ "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.",
+ "name": "forsystemvms",
+ "type": "list"
+ },
{
"description": "the netmask of the Pod",
"name": "netmask",
"type": "string"
},
{
- "description": "the Zone ID of the Pod",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "the gateway of the Pod",
- "name": "gateway",
- "type": "string"
- },
- {
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
{
- "description": "the Zone name of the Pod",
- "name": "zonename",
+ "description": "the Zone ID of the Pod",
+ "name": "zoneid",
"type": "string"
},
{
@@ -23176,8 +23129,55 @@
},
{},
{
- "description": "the allocation state of the Pod",
- "name": "allocationstate",
+ "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.",
+ "name": "startip",
+ "type": "list"
+ },
+ {
+ "description": "the name of the Pod",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "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 IP ranges for the Pod",
+ "name": "ipranges",
+ "response": [
+ {
+ "description": "indicates if range is dedicated for CPVM and SSVM",
+ "name": "forsystemvms",
+ "type": "string"
+ },
+ {
+ "description": "the ending IP for the range",
+ "name": "endip",
+ "type": "string"
+ },
+ {
+ "description": "indicates Vlan ID for the range",
+ "name": "vlanid",
+ "type": "string"
+ },
+ {
+ "description": "the starting IP for the range",
+ "name": "startip",
+ "type": "string"
+ }
+ ],
+ "type": "list"
+ },
+ {
+ "description": "the gateway of the Pod",
+ "name": "gateway",
"type": "string"
}
]
@@ -23199,83 +23199,8 @@
"related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx",
"response": [
{
- "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 state of the router",
- "name": "state",
- "type": "state"
- },
- {
- "description": "the project name of the address",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the ID of the corresponding guest network",
- "name": "guestnetworkid",
- "type": "string"
- },
- {
- "description": "the public netmask for the router",
- "name": "publicnetmask",
- "type": "string"
- },
- {
- "description": "if this router is an redundant virtual router",
- "name": "isredundantrouter",
- "type": "boolean"
- },
- {
- "description": "the name of the service offering of the virtual machine",
- "name": "serviceofferingname",
- "type": "string"
- },
- {
- "description": "the version of scripts",
- "name": "scriptsversion",
- "type": "string"
- },
- {
- "description": "the link local netmask for the router",
- "name": "linklocalnetmask",
- "type": "string"
- },
- {
- "description": "the name of the router",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the id of the router",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the template name for the router",
- "name": "templatename",
- "type": "string"
- },
- {
- "description": "the hostname for the router",
- "name": "hostname",
- "type": "string"
- },
- {
- "description": "the hypervisor on which the template runs",
- "name": "hypervisor",
- "type": "string"
- },
- {
- "description": "the guest netmask for the router",
- "name": "guestnetmask",
+ "description": "the domain associated with the router",
+ "name": "domain",
"type": "string"
},
{
@@ -23284,259 +23209,8 @@
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the public MAC address for the router",
- "name": "publicmacaddress",
- "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 ID of the corresponding link local network",
- "name": "linklocalnetworkid",
- "type": "string"
- },
- {
- "description": "the list of nics associated with the router",
- "name": "nic",
- "response": [
- {
- "description": "Type of adapter if available",
- "name": "adaptertype",
- "type": "string"
- },
- {
- "description": "Id of the vm to which the nic belongs",
- "name": "virtualmachineid",
- "type": "string"
- },
- {
- "description": "the broadcast uri of the nic",
- "name": "broadcasturi",
- "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 gateway of the nic",
- "name": "gateway",
- "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": "the gateway of IPv6 network",
- "name": "ip6gateway",
- "type": "string"
- },
- {
- "description": "the isolated private VLAN type if available",
- "name": "isolatedpvlantype",
- "type": "string"
- },
- {
- "description": "the extra dhcp options on the nic",
- "name": "extradhcpoption",
- "type": "list"
- },
- {
- "description": "the Secondary ipv4 addr of nic",
- "name": "secondaryip",
- "type": "list"
- },
- {
- "description": "true if nic is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
- },
- {
- "description": "true if nic is default, false otherwise",
- "name": "macaddress",
- "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 ID of the nic",
- "name": "id",
- "type": "string"
- },
- {
- "description": "Id of the NSX Logical Switch (if NSX based), null otherwise",
- "name": "nsxlogicalswitch",
- "type": "string"
- },
- {
- "description": "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 Port (if NSX based), null otherwise",
- "name": "nsxlogicalswitchport",
- "type": "string"
- },
- {
- "description": "the isolated private VLAN if available",
- "name": "isolatedpvlan",
- "type": "integer"
- },
- {
- "description": "the name of the corresponding network",
- "name": "networkname",
- "type": "string"
- },
- {
- "description": "the isolation uri of the nic",
- "name": "isolationuri",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the network domain for the router",
- "name": "networkdomain",
- "type": "string"
- },
- {
- "description": "the domain ID associated with the router",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the Zone name for the router",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "the ID of the service offering of the virtual machine",
- "name": "serviceofferingid",
- "type": "string"
- },
- {
- "description": "true if the router template requires upgrader",
- "name": "requiresupgrade",
- "type": "boolean"
- },
- {},
- {
- "description": "the template ID for the router",
- "name": "templateid",
- "type": "string"
- },
- {
- "description": "the public IP address for the router",
- "name": "publicip",
- "type": "string"
- },
- {
- "description": "the gateway for the router",
- "name": "gateway",
- "type": "string"
- },
- {
- "description": "the account associated with the router",
- "name": "account",
- "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": "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 date this VPC was created",
- "name": "lastupdated",
- "type": "date"
- },
- {
- "description": "detailed response generated on running health check",
- "name": "details",
- "type": "string"
- },
- {
- "description": "the type of the health check - basic or advanced",
- "name": "checktype",
- "type": "string"
- }
- ],
- "type": "list"
- },
- {
- "description": "the guest IP address for the router",
- "name": "guestipaddress",
+ "description": "the name of the corresponding guest network",
+ "name": "guestnetworkname",
"type": "string"
},
{
@@ -23545,34 +23219,14 @@
"type": "string"
},
{
- "description": "the first DNS for the router",
- "name": "dns1",
+ "description": "the Zone ID for the router",
+ "name": "zoneid",
"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": "role of the domain router",
- "name": "role",
- "type": "string"
- },
- {
- "description": "the link local IP address for the router",
- "name": "linklocalip",
- "type": "string"
- },
- {
- "description": "VPC the router belongs to",
- "name": "vpcid",
- "type": "string"
+ "description": "the state of the router",
+ "name": "state",
+ "type": "state"
},
{
"description": "the UUID of the latest async job acting on this object",
@@ -23580,15 +23234,52 @@
"type": "string"
},
{
- "description": "the Pod name for the router",
- "name": "podname",
+ "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 template name for the router",
+ "name": "templatename",
+ "type": "string"
+ },
+ {
+ "description": "if this router is an redundant virtual router",
+ "name": "isredundantrouter",
+ "type": "boolean"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
{
"description": "the name of VPC the router belongs to",
"name": "vpcname",
"type": "string"
},
+ {},
+ {
+ "description": "the version of scripts",
+ "name": "scriptsversion",
+ "type": "string"
+ },
+ {
+ "description": "the first DNS for the router",
+ "name": "dns1",
+ "type": "string"
+ },
+ {
+ "description": "role of the domain router",
+ "name": "role",
+ "type": "string"
+ },
{
"description": "the link local MAC address for the router",
"name": "linklocalmacaddress",
@@ -23600,23 +23291,332 @@
"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 date this VPC was created",
+ "name": "lastupdated",
+ "type": "date"
+ },
+ {
+ "description": "the type of the health check - basic or advanced",
+ "name": "checktype",
+ "type": "string"
+ },
+ {
+ "description": "detailed response generated on running health check",
+ "name": "details",
+ "type": "string"
+ },
+ {
+ "description": "result of the health check",
+ "name": "success",
+ "type": "boolean"
+ }
+ ],
+ "type": "list"
+ },
+ {
+ "description": "the ID of the corresponding public network",
+ "name": "publicnetworkid",
+ "type": "string"
+ },
+ {
+ "description": "the first IPv6 DNS for the router",
+ "name": "ip6dns1",
+ "type": "string"
+ },
+ {
+ "description": "the template ID for the router",
+ "name": "templateid",
+ "type": "string"
+ },
+ {
+ "description": "the project id of the ipaddress",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "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",
+ "type": "string"
+ },
+ {
+ "description": "the network domain for the router",
+ "name": "networkdomain",
+ "type": "string"
+ },
+ {
+ "description": "the gateway for the router",
+ "name": "gateway",
+ "type": "string"
+ },
+ {
"description": "the state of redundant virtual router",
"name": "redundantstate",
"type": "string"
},
{
+ "description": "the public IP address for the router",
+ "name": "publicip",
+ "type": "string"
+ },
+ {
+ "description": "the hypervisor on which the template runs",
+ "name": "hypervisor",
+ "type": "string"
+ },
+ {
+ "description": "the id of the router",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "true if any health checks had failed",
+ "name": "healthchecksfailed",
+ "type": "boolean"
+ },
+ {
+ "description": "the guest IP address for the router",
+ "name": "guestipaddress",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the router",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the name of the router",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the guest netmask for the router",
+ "name": "guestnetmask",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID associated with the router",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
"description": "the version of template",
"name": "version",
"type": "string"
},
{
- "description": "the Zone ID for the router",
- "name": "zoneid",
+ "description": "the public MAC address for the router",
+ "name": "publicmacaddress",
"type": "string"
},
{
- "description": "the ID of the corresponding public network",
- "name": "publicnetworkid",
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "true if the router template requires upgrader",
+ "name": "requiresupgrade",
+ "type": "boolean"
+ },
+ {
+ "description": "the Pod name for the router",
+ "name": "podname",
+ "type": "string"
+ },
+ {
+ "description": "the public netmask for the router",
+ "name": "publicnetmask",
+ "type": "string"
+ },
+ {
+ "description": "the date and time the router was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the list of nics associated with the router",
+ "name": "nic",
+ "response": [
+ {
+ "description": "the extra dhcp options on the nic",
+ "name": "extradhcpoption",
+ "type": "list"
+ },
+ {
+ "description": "the name of the corresponding network",
+ "name": "networkname",
+ "type": "string"
+ },
+ {
+ "description": "the broadcast uri of the nic",
+ "name": "broadcasturi",
+ "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 type of the nic",
+ "name": "type",
+ "type": "string"
+ },
+ {
+ "description": "the Secondary ipv4 addr of nic",
+ "name": "secondaryip",
+ "type": "list"
+ },
+ {
+ "description": "ID of the VLAN/VNI if available",
+ "name": "vlanid",
+ "type": "integer"
+ },
+ {
+ "description": "the isolation uri of the nic",
+ "name": "isolationuri",
+ "type": "string"
+ },
+ {
+ "description": "the IPv6 address of network",
+ "name": "ip6address",
+ "type": "string"
+ },
+ {
+ "description": "the isolated private VLAN if available",
+ "name": "isolatedpvlan",
+ "type": "integer"
+ },
+ {
+ "description": "device id for the network when plugged into the virtual machine",
+ "name": "deviceid",
+ "type": "string"
+ },
+ {
+ "description": "the ip address of the nic",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "the gateway of IPv6 network",
+ "name": "ip6gateway",
+ "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 traffic type of the nic",
+ "name": "traffictype",
+ "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 ID of the nic",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the corresponding network",
+ "name": "networkid",
+ "type": "string"
+ },
+ {
+ "description": "Type of adapter if available",
+ "name": "adaptertype",
+ "type": "string"
+ },
+ {
+ "description": "Id of the NSX Logical Switch (if NSX based), null otherwise",
+ "name": "nsxlogicalswitch",
+ "type": "string"
+ },
+ {
+ "description": "the netmask of the nic",
+ "name": "netmask",
+ "type": "string"
+ },
+ {
+ "description": "the cidr of IPv6 network",
+ "name": "ip6cidr",
+ "type": "string"
+ },
+ {
+ "description": "Id of the vm to which the nic belongs",
+ "name": "virtualmachineid",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the Zone name for the router",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the address",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the second DNS for the router",
+ "name": "dns2",
+ "type": "string"
+ },
+ {
+ "description": "the hostname for the router",
+ "name": "hostname",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the corresponding link local network",
+ "name": "linklocalnetworkid",
+ "type": "string"
+ },
+ {
+ "description": "the link local netmask for the router",
+ "name": "linklocalnetmask",
+ "type": "string"
+ },
+ {
+ "description": "the name of the service offering of the virtual machine",
+ "name": "serviceofferingname",
"type": "string"
},
{
@@ -23632,41 +23632,9 @@
"name": "updateDiskOffering",
"params": [
{
- "description": "ID of the disk offering",
+ "description": "io requests write rate of the disk offering",
"length": 255,
- "name": "id",
- "related": "createDiskOffering,updateDiskOffering,listDiskOfferings",
- "required": true,
- "type": "uuid"
- },
- {
- "description": "length (in seconds) of the burst",
- "length": 255,
- "name": "byteswriteratemaxlength",
- "required": false,
- "since": "4.15",
- "type": "long"
- },
- {
- "description": "length (in seconds) of the burst",
- "length": 255,
- "name": "iopsreadratemaxlength",
- "required": false,
- "since": "4.15",
- "type": "long"
- },
- {
- "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings",
- "length": 255,
- "name": "zoneid",
- "required": false,
- "since": "4.13",
- "type": "string"
- },
- {
- "description": "bytes write rate of the disk offering",
- "length": 255,
- "name": "byteswriterate",
+ "name": "iopswriterate",
"required": false,
"since": "4.15",
"type": "long"
@@ -23680,19 +23648,19 @@
"type": "long"
},
{
- "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": "burst bytes write rate of the disk offering",
+ "description": "an optional field, whether to display the offering to the end user or not.",
"length": 255,
- "name": "byteswriteratemax",
+ "name": "displayoffering",
"required": false,
- "since": "4.15",
- "type": "long"
+ "type": "boolean"
},
{
"description": "burst bytes read rate of the disk offering",
@@ -23703,30 +23671,30 @@
"type": "long"
},
{
- "description": "length (in seconds) of the burst",
+ "description": "comma-separated list of tags for the disk offering, tags should match with existing storage pool tags",
"length": 255,
- "name": "iopswriteratemaxlength",
- "required": false,
- "since": "4.15",
- "type": "long"
- },
- {
- "description": "bytes read rate of the disk offering",
- "length": 255,
- "name": "bytesreadrate",
- "required": false,
- "since": "4.15",
- "type": "long"
- },
- {
- "description": "the cache mode to use for this disk offering",
- "length": 255,
- "name": "cachemode",
+ "name": "tags",
"required": false,
"since": "4.15",
"type": "string"
},
{
+ "description": "ID of the disk offering",
+ "length": 255,
+ "name": "id",
+ "related": "createDiskOffering,updateDiskOffering,listDiskOfferings",
+ "required": true,
+ "type": "uuid"
+ },
+ {
+ "description": "burst requests read rate of the disk offering",
+ "length": 255,
+ "name": "iopsreadratemax",
+ "required": false,
+ "since": "4.15",
+ "type": "long"
+ },
+ {
"description": "sort key of the disk offering, integer",
"length": 255,
"name": "sortkey",
@@ -23742,9 +23710,9 @@
"type": "long"
},
{
- "description": "burst requests read rate of the disk offering",
+ "description": "bytes write rate of the disk offering",
"length": 255,
- "name": "iopsreadratemax",
+ "name": "byteswriterate",
"required": false,
"since": "4.15",
"type": "long"
@@ -23757,32 +23725,33 @@
"type": "string"
},
{
- "description": "io requests write rate of the disk offering",
+ "description": "length (in seconds) of the burst",
"length": 255,
- "name": "iopswriterate",
+ "name": "byteswriteratemaxlength",
"required": false,
"since": "4.15",
"type": "long"
},
{
- "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": "iopswriteratemaxlength",
"required": false,
- "type": "boolean"
+ "since": "4.15",
+ "type": "long"
},
{
- "description": "the ID of the containing domain(s) as comma separated string, public for public offerings",
+ "description": "burst bytes write rate of the disk offering",
"length": 255,
- "name": "domainid",
+ "name": "byteswriteratemax",
"required": false,
- "since": "4.13",
- "type": "string"
+ "since": "4.15",
+ "type": "long"
},
{
- "description": "comma-separated list of tags for the disk offering, tags should match with existing storage pool tags",
+ "description": "the cache mode to use for this disk offering",
"length": 255,
- "name": "tags",
+ "name": "cachemode",
"required": false,
"since": "4.15",
"type": "string"
@@ -23794,121 +23763,60 @@
"required": false,
"since": "4.15",
"type": "long"
+ },
+ {
+ "description": "updates name of the disk offering with this value",
+ "length": 255,
+ "name": "name",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "bytes read rate of the disk offering",
+ "length": 255,
+ "name": "bytesreadrate",
+ "required": false,
+ "since": "4.15",
+ "type": "long"
+ },
+ {
+ "description": "length (in seconds) of the burst",
+ "length": 255,
+ "name": "iopsreadratemaxlength",
+ "required": false,
+ "since": "4.15",
+ "type": "long"
+ },
+ {
+ "description": "the ID of the containing domain(s) as comma separated string, public for public offerings",
+ "length": 255,
+ "name": "domainid",
+ "required": false,
+ "since": "4.13",
+ "type": "string"
}
],
"related": "createDiskOffering,listDiskOfferings",
"response": [
{
- "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
- "name": "zoneid",
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
- "description": "burst io requests write rate of the disk offering",
- "name": "diskIopsWriteRateMax",
- "type": "long"
- },
- {
- "description": "the vsphere storage policy tagged to the disk offering in case of VMware",
- "name": "vspherestoragepolicy",
- "type": "string"
- },
- {},
- {
- "description": "the tags for the disk offering",
- "name": "tags",
- "type": "string"
- },
- {
- "description": "bytes read rate of the disk offering",
- "name": "diskBytesReadRate",
- "type": "long"
- },
- {
- "description": "the min iops of the disk offering",
- "name": "miniops",
- "type": "long"
- },
- {
- "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "length (in seconds) of the burst",
- "name": "diskBytesWriteRateMaxLength",
- "type": "long"
- },
- {
- "description": "io requests write rate of the disk offering",
- "name": "diskIopsWriteRate",
- "type": "long"
- },
- {
- "description": "whether to display the offering to the end user or not.",
- "name": "displayoffering",
- "type": "boolean"
- },
- {
- "description": "the size of the disk offering in GB",
- "name": "disksize",
- "type": "long"
- },
- {
- "description": "bytes write rate of the disk offering",
- "name": "diskBytesWriteRate",
- "type": "long"
- },
- {
- "description": "length (in seconds) of the burst",
- "name": "diskIopsWriteRateMaxLength",
- "type": "long"
- },
- {
- "description": "the date this disk offering was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the max iops of the disk offering",
- "name": "maxiops",
- "type": "long"
- },
- {
- "description": "an alternate display text of the disk offering.",
- "name": "displaytext",
- "type": "string"
- },
- {},
- {
- "description": "length (in second) of the burst",
- "name": "diskIopsReadRateMaxLength",
- "type": "long"
- },
- {
"description": "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": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the name of the disk offering",
- "name": "name",
- "type": "string"
+ "description": "burst bytes write rate of the disk offering",
+ "name": "diskBytesWriteRateMax",
+ "type": "long"
},
{
"description": "io requests read rate of the disk offering",
@@ -23916,29 +23824,25 @@
"type": "long"
},
{
- "description": "the cache mode to use for this disk offering. none, writeback or writethrough",
- "name": "cacheMode",
+ "description": "an alternate display text of the disk offering.",
+ "name": "displaytext",
"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": "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",
+ "description": "length (in seconds) of the burst",
+ "name": "diskBytesWriteRateMaxLength",
"type": "long"
},
+ {},
{
- "description": "unique ID of the disk offering",
- "name": "id",
- "type": "string"
+ "description": "the date this disk offering was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "bytes write rate of the disk offering",
+ "name": "diskBytesWriteRate",
+ "type": "long"
},
{
"description": "burst io requests read rate of the disk offering",
@@ -23946,13 +23850,44 @@
"type": "long"
},
{
- "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": "burst bytes read rate of the disk offering",
- "name": "diskBytesReadRateMax",
+ "description": "the max iops of the disk offering",
+ "name": "maxiops",
+ "type": "long"
+ },
+ {
+ "description": "bytes read rate of the disk offering",
+ "name": "diskBytesReadRate",
+ "type": "long"
+ },
+ {
+ "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the size of the disk offering in GB",
+ "name": "disksize",
+ "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": "length (in second) of the burst",
+ "name": "diskIopsReadRateMaxLength",
"type": "long"
},
{
@@ -23961,19 +23896,84 @@
"type": "boolean"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "true if disk offering uses custom iops, false otherwise",
+ "name": "iscustomizediops",
+ "type": "boolean"
+ },
+ {
+ "description": "whether to display the offering to the end user or not.",
+ "name": "displayoffering",
+ "type": "boolean"
+ },
+ {
+ "description": "the cache mode to use for this disk offering. none, writeback or writethrough",
+ "name": "cacheMode",
"type": "string"
},
{
+ "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "burst bytes read rate of the disk offering",
+ "name": "diskBytesReadRateMax",
+ "type": "long"
+ },
+ {
+ "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",
"type": "string"
},
{
- "description": "the storage type for this disk offering",
- "name": "storagetype",
+ "description": "io requests write rate of the disk offering",
+ "name": "diskIopsWriteRate",
+ "type": "long"
+ },
+ {
+ "description": "true if disk offering uses custom size, false otherwise",
+ "name": "iscustomized",
+ "type": "boolean"
+ },
+ {
+ "description": "unique ID of the disk offering",
+ "name": "id",
"type": "string"
+ },
+ {
+ "description": "burst io requests write rate of the disk offering",
+ "name": "diskIopsWriteRateMax",
+ "type": "long"
+ },
+ {
+ "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
+ "name": "zone",
+ "type": "string"
+ },
+ {
+ "description": "the tags for the disk offering",
+ "name": "tags",
+ "type": "string"
+ },
+ {
+ "description": "the min iops of the disk offering",
+ "name": "miniops",
+ "type": "long"
+ },
+ {
+ "description": "the vsphere storage policy tagged to the disk offering in case of VMware",
+ "name": "vspherestoragepolicy",
+ "type": "string"
+ },
+ {
+ "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)",
+ "name": "hypervisorsnapshotreserve",
+ "type": "integer"
}
]
},
@@ -23997,9 +23997,53 @@
"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": "Stops a running Kubernetes cluster",
+ "isasync": true,
+ "name": "stopKubernetesCluster",
+ "params": [
+ {
+ "description": "the ID of the Kubernetes cluster",
+ "length": 255,
+ "name": "id",
+ "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster",
+ "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"
@@ -24008,11 +24052,6 @@
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
- },
- {
- "description": "true if operation is executed successfully",
- "name": "success",
- "type": "boolean"
}
]
},
@@ -24022,12 +24061,11 @@
"name": "addAccountToProject",
"params": [
{
- "description": "ID of the project to add the account to",
+ "description": "email to which invitation to the project is going to be sent",
"length": 255,
- "name": "projectid",
- "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject",
- "required": true,
- "type": "uuid"
+ "name": "email",
+ "required": false,
+ "type": "string"
},
{
"description": "name of the account to be added to the project",
@@ -24037,51 +24075,52 @@
"type": "string"
},
{
- "description": "Project role type to be assigned to the user - Admin/Regular; default: Regular",
- "length": 255,
- "name": "roletype",
- "required": false,
- "type": "string"
- },
- {
- "description": "email to which invitation to the project is going to be sent",
- "length": 255,
- "name": "email",
- "required": false,
- "type": "string"
- },
- {
"description": "ID of the project role",
"length": 255,
"name": "projectroleid",
"related": "createProjectRole,listProjectRoles,updateProjectRole",
"required": false,
"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": "ID of the project to add the account to",
+ "length": 255,
+ "name": "projectid",
+ "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject",
+ "required": true,
+ "type": "uuid"
}
],
"response": [
{
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
"description": "any text associated with the success or failure",
"name": "displaytext",
"type": "string"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {},
- {
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
- {},
{
"description": "true if operation is executed successfully",
"name": "success",
"type": "boolean"
- }
+ },
+ {},
+ {}
],
"since": "3.0.0"
},
@@ -24091,32 +24130,11 @@
"name": "listSnapshots",
"params": [
{
- "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"
- },
- {
- "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY.",
- "length": 255,
- "name": "intervaltype",
- "required": false,
- "type": "string"
- },
- {
- "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false",
- "length": 255,
- "name": "listall",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "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"
+ "type": "map"
},
{
"description": "lists snapshot by snapshot ID",
@@ -24134,17 +24152,39 @@
"type": "integer"
},
{
- "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",
"length": 255,
- "name": "tags",
+ "name": "listall",
"required": false,
- "type": "map"
+ "type": "boolean"
},
{
- "description": "list snapshots by zone id",
+ "description": "list resources by account. Must be used with the domainId parameter.",
"length": 255,
- "name": "zoneid",
- "related": "createZone,updateZone,listZones,listZones",
+ "name": "account",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY.",
+ "length": 255,
+ "name": "intervaltype",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the ID of the disk volume",
+ "length": 255,
+ "name": "volumeid",
+ "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "list only resources belonging to the domain specified",
+ "length": 255,
+ "name": "domainid",
+ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
"required": false,
"type": "uuid"
},
@@ -24156,10 +24196,17 @@
"type": "string"
},
{
- "description": "list only resources belonging to the domain specified",
+ "description": "",
"length": 255,
- "name": "domainid",
- "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "list snapshots by zone id",
+ "length": 255,
+ "name": "zoneid",
+ "related": "createZone,updateZone,listZones,listZones",
"required": false,
"type": "uuid"
},
@@ -24172,21 +24219,11 @@
"type": "uuid"
},
{
- "description": "the ID of the disk volume",
+ "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
"length": 255,
- "name": "volumeid",
- "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume",
+ "name": "isrecursive",
"required": false,
- "type": "uuid"
- },
- {
- "description": "the IDs of the snapshots, mutually exclusive with id",
- "length": 255,
- "name": "ids",
- "related": "createSnapshot,createSnapshotFromVMSnapshot,archiveSnapshot,listSnapshots,revertSnapshot",
- "required": false,
- "since": "4.9",
- "type": "list"
+ "type": "boolean"
},
{
"description": "List by keyword",
@@ -24203,69 +24240,20 @@
"type": "string"
},
{
- "description": "",
+ "description": "the IDs of the snapshots, mutually exclusive with id",
"length": 255,
- "name": "page",
+ "name": "ids",
+ "related": "createSnapshot,createSnapshotFromVMSnapshot,archiveSnapshot,listSnapshots,revertSnapshot",
"required": false,
- "type": "integer"
+ "since": "4.9",
+ "type": "list"
}
],
"related": "createSnapshot,createSnapshotFromVMSnapshot,archiveSnapshot,revertSnapshot",
"response": [
{
- "description": "name of the disk volume",
- "name": "volumename",
- "type": "string"
- },
- {
- "description": "name of the snapshot",
- "name": "name",
- "type": "string"
- },
- {
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "type of the disk volume",
- "name": "volumetype",
- "type": "string"
- },
- {},
- {
- "description": " the date the snapshot was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "id of the availability zone",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the type of the snapshot",
- "name": "snapshottype",
- "type": "string"
- },
- {
- "description": "the domain name of the snapshot's account",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "ID of the disk volume",
- "name": "volumeid",
- "type": "string"
- },
- {
- "description": "valid location types are primary and secondary.",
- "name": "locationtype",
- "type": "string"
- },
- {
- "description": "the domain ID of the snapshot's account",
- "name": "domainid",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
@@ -24274,13 +24262,8 @@
"type": "string"
},
{
- "description": "physical size of backedup snapshot on image store",
- "name": "physicalsize",
- "type": "long"
- },
- {
- "description": "display name of the os on volume",
- "name": "osdisplayname",
+ "description": "the project id of the snapshot",
+ "name": "projectid",
"type": "string"
},
{
@@ -24288,14 +24271,35 @@
"name": "project",
"type": "string"
},
+ {},
+ {
+ "description": "name of the disk volume",
+ "name": "volumename",
+ "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": "ID of the snapshot",
- "name": "id",
+ "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage",
+ "name": "state",
+ "type": "state"
+ },
+ {
+ "description": "display name of the os on volume",
+ "name": "osdisplayname",
+ "type": "string"
+ },
+ {
+ "description": "id of the os on volume",
+ "name": "ostypeid",
"type": "string"
},
{
@@ -24304,17 +24308,88 @@
"type": "long"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the type of the snapshot",
+ "name": "snapshottype",
"type": "string"
},
{
+ "description": "name of the snapshot",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "ID of the disk volume",
+ "name": "volumeid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "ID of the snapshot",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": " the date the snapshot was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "physical size of backedup snapshot on image store",
+ "name": "physicalsize",
+ "type": "long"
+ },
+ {
+ "description": "the domain ID of the snapshot's account",
+ "name": "domainid",
+ "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": "the account associated with the snapshot",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "indicates whether the underlying storage supports reverting the volume to this snapshot",
+ "name": "revertable",
+ "type": "boolean"
+ },
+ {
"description": "the list of resource tags associated",
"name": "tags",
"response": [
{
- "description": "id of the resource",
- "name": "resourceid",
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
"type": "string"
},
{
@@ -24323,8 +24398,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"
},
{
@@ -24338,57 +24413,21 @@
"type": "string"
},
{
- "description": "customer associated with the tag",
- "name": "customer",
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
"type": "string"
},
{
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "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"
}
],
"type": "set"
},
{
- "description": "the project id of the snapshot",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "indicates whether the underlying storage supports reverting the volume to this snapshot",
- "name": "revertable",
- "type": "boolean"
- },
- {
- "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage",
- "name": "state",
- "type": "state"
- },
- {
- "description": "the account associated with the snapshot",
- "name": "account",
- "type": "string"
- },
- {},
- {
- "description": "id of the os on volume",
- "name": "ostypeid",
+ "description": "id of the availability zone",
+ "name": "zoneid",
"type": "string"
}
]
@@ -24399,13 +24438,6 @@
"name": "resetVpnConnection",
"params": [
{
- "description": "an optional account for connection. Must be used with domainId.",
- "length": 255,
- "name": "account",
- "required": false,
- "type": "string"
- },
- {
"description": "an optional domainId for connection. If the account parameter is used, domainId must also be used.",
"length": 255,
"name": "domainid",
@@ -24414,6 +24446,13 @@
"type": "uuid"
},
{
+ "description": "an optional account for connection. Must be used with domainId.",
+ "length": 255,
+ "name": "account",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "id of vpn connection",
"length": 255,
"name": "id",
@@ -24425,141 +24464,408 @@
"related": "createVpnConnection,listVpnConnections,updateVpnConnection",
"response": [
{
- "description": "the date and time the host was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the public IP address",
- "name": "publicip",
- "type": "string"
- },
- {
- "description": "ESP policy of the customer gateway",
- "name": "esppolicy",
- "type": "string"
- },
- {
- "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": "is connection for display to the regular user",
- "name": "fordisplay",
- "type": "boolean"
- },
- {
- "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike",
- "name": "ikeversion",
- "type": "string"
- },
- {
- "description": "if DPD is enabled for customer gateway",
- "name": "dpd",
- "type": "boolean"
- },
- {
- "description": "Lifetime of ESP SA of customer gateway",
- "name": "esplifetime",
- "type": "long"
- },
- {
- "description": "the customer gateway ID",
- "name": "s2scustomergatewayid",
- "type": "string"
- },
- {
- "description": "IKE policy of the customer gateway",
- "name": "ikepolicy",
- "type": "string"
- },
- {
- "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": "State of vpn connection",
- "name": "state",
- "type": "string"
- },
- {},
- {
- "description": "the connection ID",
- "name": "id",
- "type": "string"
- },
- {
- "description": "public ip address id of the customer gateway",
- "name": "gateway",
- "type": "string"
- },
- {
- "description": "the domain name of the owner",
- "name": "domain",
- "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": "State of vpn connection",
- "name": "passive",
- "type": "boolean"
- },
- {
- "description": "the date and time the host was removed",
- "name": "removed",
- "type": "date"
- },
- {
- "description": "the owner",
- "name": "account",
- "type": "string"
- },
- {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
{
- "description": "if Force NAT Encapsulation is enabled for customer gateway",
- "name": "forceencap",
- "type": "boolean"
+ "description": "the connection ID",
+ "name": "id",
+ "type": "string"
},
{
"description": "the domain id of the owner",
"name": "domainid",
"type": "string"
},
+ {
+ "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike",
+ "name": "ikeversion",
+ "type": "string"
+ },
{},
{
+ "description": "the vpn gateway ID",
+ "name": "s2svpngatewayid",
+ "type": "string"
+ },
+ {
+ "description": "if Force NAT Encapsulation is enabled for customer gateway",
+ "name": "forceencap",
+ "type": "boolean"
+ },
+ {
+ "description": "if DPD is enabled for customer gateway",
+ "name": "dpd",
+ "type": "boolean"
+ },
+ {
+ "description": "ESP policy of the customer gateway",
+ "name": "esppolicy",
+ "type": "string"
+ },
+ {
+ "description": "the project name",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the public IP address",
+ "name": "publicip",
+ "type": "string"
+ },
+ {
+ "description": "State of vpn connection",
+ "name": "passive",
+ "type": "boolean"
+ },
+ {
+ "description": "Lifetime of IKE SA of customer gateway",
+ "name": "ikelifetime",
+ "type": "long"
+ },
+ {
+ "description": "is connection for display to the regular user",
+ "name": "fordisplay",
+ "type": "boolean"
+ },
+ {
+ "description": "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 date and time the host was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the domain name of the owner",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "State of vpn connection",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "the customer gateway ID",
+ "name": "s2scustomergatewayid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "IKE policy of the customer gateway",
+ "name": "ikepolicy",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
"description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).",
"name": "cidrlist",
"type": "string"
+ },
+ {
+ "description": "IPsec Preshared-Key of the customer gateway",
+ "name": "ipsecpsk",
+ "type": "string"
+ },
+ {
+ "description": "the owner",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "Lifetime of ESP SA of customer gateway",
+ "name": "esplifetime",
+ "type": "long"
+ }
+ ]
+ },
+ {
+ "description": "Lists Kubernetes clusters",
+ "isasync": false,
+ "name": "listKubernetesClusters",
+ "params": [
+ {
+ "description": "list resources by account. Must be used with the domainId parameter.",
+ "length": 255,
+ "name": "account",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "list objects by project",
+ "length": 255,
+ "name": "projectid",
+ "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "list only resources belonging to the domain specified",
+ "length": 255,
+ "name": "domainid",
+ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "state of the Kubernetes cluster",
+ "length": 255,
+ "name": "state",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "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": "name",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
+ "length": 255,
+ "name": "isrecursive",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "the ID of the Kubernetes cluster",
+ "length": 255,
+ "name": "id",
+ "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster",
+ "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",
+ "length": 255,
+ "name": "listall",
+ "required": false,
+ "type": "boolean"
+ }
+ ],
+ "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster",
+ "response": [
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain in which the Kubernetes cluster exists",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the Kubernetes cluster",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the name of the service offering of the Kubernetes cluster",
+ "name": "serviceofferingname",
+ "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": "the name of the domain in which the Kubernetes cluster exists",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the name of the Kubernetes version for the Kubernetes cluster",
+ "name": "kubernetesversionname",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the id of the Kubernetes cluster",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the Kubernetes cluster",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.",
+ "name": "masternodes",
+ "type": "long"
+ },
+ {},
+ {
+ "description": "Public IP Address of the cluster",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "URL end point for the Kubernetes cluster",
+ "name": "endpoint",
+ "type": "string"
+ },
+ {
+ "description": "the description of the Kubernetes cluster",
+ "name": "description",
+ "type": "string"
+ },
+ {
+ "description": "URL end point for the Kubernetes cluster dashboard UI",
+ "name": "consoleendpoint",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the ID of the Kubernetes version for the Kubernetes cluster",
+ "name": "kubernetesversionid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the network of the Kubernetes cluster",
+ "name": "associatednetworkname",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the template of the Kubernetes cluster",
+ "name": "templateid",
+ "type": "string"
+ },
+ {
+ "description": "the state of the Kubernetes cluster",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "the name of the zone of the Kubernetes cluster",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the Kubernetes cluster",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the service offering of the Kubernetes cluster",
+ "name": "serviceofferingid",
+ "type": "string"
+ },
+ {
+ "description": "Minimum size of the cluster",
+ "name": "minsize",
+ "type": "long"
+ },
+ {
+ "description": "Maximum size of the cluster",
+ "name": "maxsize",
+ "type": "long"
+ },
+ {
+ "description": "the control nodes count for the Kubernetes cluster",
+ "name": "controlnodes",
+ "type": "long"
+ },
+ {
+ "description": "Whether autoscaling is enabled for the cluster",
+ "name": "autoscalingenabled",
+ "type": "boolean"
+ },
+ {
+ "description": "the project id of the Kubernetes cluster",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the size (worker nodes count) of the Kubernetes cluster",
+ "name": "size",
+ "type": "long"
+ },
+ {
+ "description": "keypair details",
+ "name": "keypair",
+ "type": "string"
+ },
+ {
+ "description": "the name of the zone of the Kubernetes cluster",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "Public IP Address ID of the cluster",
+ "name": "ipaddressid",
+ "type": "string"
+ },
+ {
+ "description": "the memory the Kubernetes cluster",
+ "name": "memory",
+ "type": "string"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the cpu cores of the Kubernetes cluster",
+ "name": "cpunumber",
+ "type": "string"
}
]
},
@@ -24569,14 +24875,6 @@
"name": "deleteSSHKeyPair",
"params": [
{
- "description": "the domain ID associated with the keypair",
- "length": 255,
- "name": "domainid",
- "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
- "required": false,
- "type": "uuid"
- },
- {
"description": "Name of the keypair",
"length": 255,
"name": "name",
@@ -24591,6 +24889,14 @@
"type": "string"
},
{
+ "description": "the domain ID associated with the keypair",
+ "length": 255,
+ "name": "domainid",
+ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
+ "required": false,
+ "type": "uuid"
+ },
+ {
"description": "the project associated with keypair",
"length": 255,
"name": "projectid",
@@ -24601,6 +24907,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"
@@ -24613,11 +24924,6 @@
"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"
@@ -24630,14 +24936,29 @@
"name": "createAutoScaleVmGroup",
"params": [
{
- "description": "the ID of the load balancer rule",
+ "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": "lbruleid",
- "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules",
+ "name": "minmembers",
+ "required": true,
+ "type": "integer"
+ },
+ {
+ "description": "the autoscale profile that contains information about the vms in the vm group.",
+ "length": 255,
+ "name": "vmprofileid",
+ "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile",
"required": true,
"type": "uuid"
},
{
+ "description": "an optional field, whether to the display the group to the end user or not",
+ "length": 255,
+ "name": "fordisplay",
+ "required": false,
+ "since": "4.4",
+ "type": "boolean"
+ },
+ {
"description": "the frequency at which the conditions have to be evaluated",
"length": 255,
"name": "interval",
@@ -24653,21 +24974,6 @@
"type": "list"
},
{
- "description": "an optional field, whether to the display the group to the end user or not",
- "length": 255,
- "name": "fordisplay",
- "required": false,
- "since": "4.4",
- "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.",
- "length": 255,
- "name": "minmembers",
- "required": true,
- "type": "integer"
- },
- {
"description": "list of scaleup autoscale policies",
"length": 255,
"name": "scaleuppolicyids",
@@ -24676,10 +24982,10 @@
"type": "list"
},
{
- "description": "the autoscale profile that contains information about the vms in the vm group.",
+ "description": "the ID of the load balancer rule",
"length": 255,
- "name": "vmprofileid",
- "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile",
+ "name": "lbruleid",
+ "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules",
"required": true,
"type": "uuid"
},
@@ -24693,66 +24999,25 @@
],
"related": "disableAutoScaleVmGroup,enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup",
"response": [
- {},
{
- "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 UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "list of scaledown autoscale policies",
- "name": "scaledownpolicies",
+ "description": "list of scaleup autoscale policies",
+ "name": "scaleuppolicies",
"type": "list"
},
{
- "description": "the autoscale vm group ID",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the domain ID of the vm profile",
- "name": "domainid",
- "type": "string"
- },
- {},
- {
- "description": "the autoscale profile that contains information about the vms in the vm group.",
- "name": "vmprofileid",
- "type": "string"
- },
- {
"description": "the account owning the instance group",
"name": "account",
"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 current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
+ {},
{
- "description": "the project name of the vm profile",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the domain name of the vm profile",
- "name": "domain",
+ "description": "the domain ID of the vm profile",
+ "name": "domainid",
"type": "string"
},
{
@@ -24761,14 +25026,55 @@
"type": "string"
},
{
+ "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.",
+ "name": "maxmembers",
+ "type": "int"
+ },
+ {
+ "description": "the autoscale 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",
+ "type": "string"
+ },
+ {
+ "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.",
+ "name": "minmembers",
+ "type": "int"
+ },
+ {
+ "description": "list of scaledown autoscale policies",
+ "name": "scaledownpolicies",
+ "type": "list"
+ },
+ {},
+ {
+ "description": "the domain name of the vm profile",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "is group for display to the regular user",
+ "name": "fordisplay",
+ "type": "boolean"
+ },
+ {
+ "description": "the load balancer rule ID",
+ "name": "lbruleid",
+ "type": "string"
+ },
+ {
"description": "the frequency at which the conditions have to be evaluated",
"name": "interval",
"type": "int"
},
{
- "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",
@@ -24776,9 +25082,9 @@
"type": "string"
},
{
- "description": "is group for display to the regular user",
- "name": "fordisplay",
- "type": "boolean"
+ "description": "the project name of the vm profile",
+ "name": "project",
+ "type": "string"
}
]
},
@@ -24790,16 +25096,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": "query to search using",
@@ -24810,22 +25116,53 @@
"type": "string"
},
{
- "description": "",
+ "description": "List by keyword",
"length": 255,
- "name": "pagesize",
+ "name": "keyword",
"required": false,
- "type": "integer"
+ "type": "string"
}
],
"related": "listLdapUsers",
"response": [
- {},
+ {
+ "description": "The user's email",
+ "name": "email",
+ "type": "string"
+ },
{
"description": "The user's firstname",
"name": "firstname",
"type": "string"
},
{
+ "description": "The user's lastname",
+ "name": "lastname",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {},
+ {},
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "The user's username",
+ "name": "username",
+ "type": "string"
+ },
+ {
+ "description": "The user's domain",
+ "name": "domain",
+ "type": "string"
+ },
+ {
"description": "The user's principle",
"name": "principal",
"type": "string"
@@ -24834,37 +25171,6 @@
"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",
- "type": "string"
- },
- {
- "description": "The user's username",
- "name": "username",
- "type": "string"
- },
- {
- "description": "The user's lastname",
- "name": "lastname",
- "type": "string"
- },
- {
- "description": "The user's email",
- "name": "email",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
}
],
"since": "4.2.0"
@@ -24885,11 +25191,10 @@
],
"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",
@@ -24897,14 +25202,15 @@
"type": "string"
},
{
- "description": "any text associated with the success or failure",
- "name": "displaytext",
- "type": "string"
- },
- {
"description": "true if operation is executed successfully",
"name": "success",
"type": "boolean"
+ },
+ {},
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
}
]
},
@@ -24914,6 +25220,20 @@
"name": "addBaremetalPxePingServer",
"params": [
{
+ "description": "Root directory on PING storage server",
+ "length": 255,
+ "name": "pingdir",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "Password of PING storage server",
+ "length": 255,
+ "name": "pingcifspassword",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "type of pxe device",
"length": 255,
"name": "pxeservertype",
@@ -24923,14 +25243,7 @@
{
"description": "Credentials to reach external pxe device",
"length": 255,
- "name": "username",
- "required": true,
- "type": "string"
- },
- {
- "description": "URL of the external pxe device",
- "length": 255,
- "name": "url",
+ "name": "password",
"required": true,
"type": "string"
},
@@ -24942,23 +25255,9 @@
"type": "string"
},
{
- "description": "Username of PING storage server",
+ "description": "URL of the external pxe device",
"length": 255,
- "name": "pingcifsusername",
- "required": false,
- "type": "string"
- },
- {
- "description": "PING storage server ip",
- "length": 255,
- "name": "pingstorageserverip",
- "required": true,
- "type": "string"
- },
- {
- "description": "Credentials to reach external pxe device",
- "length": 255,
- "name": "password",
+ "name": "url",
"required": true,
"type": "string"
},
@@ -24971,16 +25270,16 @@
"type": "uuid"
},
{
- "description": "Password of PING storage server",
+ "description": "Credentials to reach external pxe device",
"length": 255,
- "name": "pingcifspassword",
- "required": false,
+ "name": "username",
+ "required": true,
"type": "string"
},
{
- "description": "Root directory on PING storage server",
+ "description": "PING storage server ip",
"length": 255,
- "name": "pingdir",
+ "name": "pingstorageserverip",
"required": true,
"type": "string"
},
@@ -24991,18 +25290,31 @@
"related": "updatePod,createManagementNetworkIpRange",
"required": false,
"type": "uuid"
+ },
+ {
+ "description": "Username of PING storage server",
+ "length": 255,
+ "name": "pingcifsusername",
+ "required": false,
+ "type": "string"
}
],
"related": "",
"response": [
{
- "description": "url",
- "name": "url",
+ "description": "name of the provider",
+ "name": "provider",
"type": "string"
},
+ {},
{
- "description": "Tftp root directory of PXE server",
- "name": "tftpdir",
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "url",
+ "name": "url",
"type": "string"
},
{
@@ -25011,35 +25323,29 @@
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {},
- {},
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
"description": "the physical network to which this external dhcp device belongs to",
"name": "physicalnetworkid",
"type": "string"
},
{
- "description": "name of the provider",
- "name": "provider",
+ "description": "device id of ",
+ "name": "id",
"type": "string"
},
{
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {},
+ {
"description": "PING storage server ip",
"name": "pingstorageserverip",
"type": "string"
},
{
- "description": "device id of ",
- "name": "id",
+ "description": "Tftp root directory of PXE server",
+ "name": "tftpdir",
"type": "string"
}
]
@@ -25052,25 +25358,26 @@
{
"description": "",
"length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
- },
- {
- "description": "Id of a Region",
- "length": 255,
- "name": "regionid",
+ "name": "pagesize",
"required": false,
"type": "integer"
},
{
"description": "",
"length": 255,
- "name": "pagesize",
+ "name": "page",
"required": false,
"type": "integer"
},
{
+ "description": "Id of the portable ip range",
+ "length": 255,
+ "name": "id",
+ "related": "createPortableIpRange,listPortableIpRanges",
+ "required": false,
+ "type": "uuid"
+ },
+ {
"description": "List by keyword",
"length": 255,
"name": "keyword",
@@ -25078,19 +25385,81 @@
"type": "string"
},
{
- "description": "Id of the portable ip range",
+ "description": "Id of a Region",
"length": 255,
- "name": "id",
- "related": "createPortableIpRange,listPortableIpRanges",
+ "name": "regionid",
"required": false,
- "type": "uuid"
+ "type": "integer"
}
],
"related": "createPortableIpRange",
"response": [
{
- "description": "the ID or VID of the VLAN.",
- "name": "vlan",
+ "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": "public IP address",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "the account ID the portable IP address is associated with",
+ "name": "accountid",
+ "type": "string"
+ },
+ {
+ "description": "Region Id in which global load balancer is created",
+ "name": "regionid",
+ "type": "integer"
+ },
+ {
+ "description": "VPC the ip belongs to",
+ "name": "vpcid",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID the portable IP address is associated with",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "date the portal IP address was acquired",
+ "name": "allocated",
+ "type": "date"
+ },
+ {
+ "description": "the ID of the Network where ip belongs to",
+ "name": "networkid",
+ "type": "string"
+ },
+ {
+ "description": "State of the ip address. Can be: Allocatin, Allocated and Releasing",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the zone the public IP address belongs to",
+ "name": "zoneid",
+ "type": "string"
+ }
+ ],
+ "type": "list"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the netmask of the VLAN IP range",
+ "name": "netmask",
"type": "string"
},
{
@@ -25104,93 +25473,30 @@
"type": "string"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the start ip of the portable IP range",
+ "name": "startip",
"type": "string"
},
{
+ "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"
+ },
+ {},
+ {
"description": "portable IP range ID",
"name": "id",
"type": "string"
},
{
- "description": "the start ip of the portable IP range",
- "name": "startip",
- "type": "string"
- },
- {},
- {
"description": "the gateway of the VLAN IP range",
"name": "gateway",
"type": "string"
- },
- {
- "description": "the netmask of the VLAN IP range",
- "name": "netmask",
- "type": "string"
- },
- {
- "description": "List of portable IP and association with zone/network/vpc details that are part of GSLB rule",
- "name": "portableipaddress",
- "response": [
- {
- "description": "the account ID the portable IP address is associated with",
- "name": "accountid",
- "type": "string"
- },
- {
- "description": "the ID of the Network where ip belongs to",
- "name": "networkid",
- "type": "string"
- },
- {
- "description": "Region Id in which global load balancer is created",
- "name": "regionid",
- "type": "integer"
- },
- {
- "description": "public IP address",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "description": "the domain ID the portable IP address is associated with",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "State of the ip address. Can be: Allocatin, Allocated and Releasing",
- "name": "state",
- "type": "string"
- },
- {
- "description": "the ID of the zone the public IP address belongs to",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the physical network this belongs to",
- "name": "physicalnetworkid",
- "type": "string"
- },
- {
- "description": "date the portal IP address was acquired",
- "name": "allocated",
- "type": "date"
- },
- {
- "description": "VPC the ip belongs to",
- "name": "vpcid",
- "type": "string"
- }
- ],
- "type": "list"
- },
- {},
- {
- "description": "Region Id in which portable ip range is provisioned",
- "name": "regionid",
- "type": "integer"
}
]
},
@@ -25241,40 +25547,10 @@
"name": "listConfigurations",
"params": [
{
- "description": "lists configuration by name",
+ "description": "the ID of the Storage pool to update the parameter value for corresponding storage pool",
"length": 255,
- "name": "name",
- "required": false,
- "type": "string"
- },
- {
- "description": "lists configurations by category",
- "length": 255,
- "name": "category",
- "required": false,
- "type": "string"
- },
- {
- "description": "the ID of the Zone to update the parameter value for corresponding zone",
- "length": 255,
- "name": "zoneid",
- "related": "createZone,updateZone,listZones,listZones",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "the ID of the Image Store to update the parameter value for corresponding image store",
- "length": 255,
- "name": "imagestoreuuid",
- "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "the ID of the Cluster to update the parameter value for corresponding cluster",
- "length": 255,
- "name": "clusterid",
- "related": "addCluster,updateCluster",
+ "name": "storageid",
+ "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities",
"required": false,
"type": "uuid"
},
@@ -25287,6 +25563,21 @@
"type": "uuid"
},
{
+ "description": "lists configuration by name",
+ "length": 255,
+ "name": "name",
+ "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,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore",
+ "required": false,
+ "type": "uuid"
+ },
+ {
"description": "",
"length": 255,
"name": "pagesize",
@@ -25294,12 +25585,11 @@
"type": "integer"
},
{
- "description": "the ID of the Storage pool to update the parameter value for corresponding storage pool",
+ "description": "lists configurations by category",
"length": 255,
- "name": "storageid",
- "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities",
+ "name": "category",
"required": false,
- "type": "uuid"
+ "type": "string"
},
{
"description": "",
@@ -25309,6 +25599,22 @@
"type": "integer"
},
{
+ "description": "the ID of the Account to update the parameter value for corresponding account",
+ "length": 255,
+ "name": "accountid",
+ "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "the ID of the Cluster to update the parameter value for corresponding cluster",
+ "length": 255,
+ "name": "clusterid",
+ "related": "addCluster,updateCluster",
+ "required": false,
+ "type": "uuid"
+ },
+ {
"description": "List by keyword",
"length": 255,
"name": "keyword",
@@ -25316,63 +25622,63 @@
"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": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts",
+ "name": "zoneid",
+ "related": "createZone,updateZone,listZones,listZones",
"required": false,
"type": "uuid"
}
],
"related": "updateConfiguration",
"response": [
- {
- "description": "true if the configuration is dynamic",
- "name": "isdynamic",
- "type": "boolean"
- },
{},
{
- "description": "the name of the configuration",
- "name": "name",
- "type": "string"
- },
- {},
- {
- "description": "the value of the configuration",
- "name": "id",
- "type": "long"
- },
- {
"description": "the description of the configuration",
"name": "description",
"type": "string"
},
{
- "description": "the value of the configuration",
- "name": "value",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated",
- "name": "scope",
- "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 name of the configuration",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the value of the configuration",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "the value of the configuration",
+ "name": "id",
+ "type": "long"
+ },
+ {
"description": "the category of the configuration",
"name": "category",
"type": "string"
- }
+ },
+ {}
]
},
{
@@ -25390,16 +25696,6 @@
}
],
"response": [
- {
- "description": "any text associated with the success or failure",
- "name": "displaytext",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
{},
{
"description": "true if operation is executed successfully",
@@ -25407,10 +25703,20 @@
"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"
+ },
{}
]
},
@@ -25420,230 +25726,160 @@
"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,
"name": "nicid",
"related": "listNics",
"required": true,
"type": "uuid"
+ },
+ {
+ "description": "Secondary IP Address",
+ "length": 255,
+ "name": "ipaddress",
+ "required": false,
+ "type": "string"
}
],
"related": "",
"response": [
- {
- "description": "the ID of the nic",
- "name": "nicid",
- "type": "string"
- },
{},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
"description": "the list of Secondary ipv4 addr of nic",
"name": "secondaryip",
"type": "list"
},
+ {},
+ {
+ "description": "the ID of the secondary private IP addr",
+ "name": "id",
+ "type": "string"
+ },
{
"description": "Secondary IP address",
"name": "ipaddress",
"type": "string"
},
- {},
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the ID of the network",
- "name": "networkid",
- "type": "string"
- },
{
"description": "the ID of the vm",
"name": "virtualmachineid",
"type": "string"
},
{
- "description": "the ID of the secondary private IP addr",
- "name": "id",
- "type": "string"
- }
- ]
- },
- {
- "description": "Stops a NetScalervm.",
- "isasync": true,
- "name": "stopNetScalerVpx",
- "params": [
- {
- "description": "Force stop the VM. The caller knows the VM is stopped.",
- "length": 255,
- "name": "forced",
- "required": false,
- "type": "boolean"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
{
- "description": "the ID of the NetScaler vm",
- "length": 255,
- "name": "id",
- "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx",
- "required": true,
- "type": "uuid"
- }
- ],
- "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs",
- "response": [
- {
- "description": "the hostname for the router",
- "name": "hostname",
+ "description": "the ID of the nic",
+ "name": "nicid",
"type": "string"
},
{
- "description": "the gateway for the router",
- "name": "gateway",
- "type": "string"
- },
- {
- "description": "the ID of the corresponding link local network",
- "name": "linklocalnetworkid",
- "type": "string"
- },
- {
- "description": "the template name for the router",
- "name": "templatename",
- "type": "string"
- },
- {
- "description": "the hypervisor on which the template runs",
- "name": "hypervisor",
- "type": "string"
- },
- {
- "description": "the project name of the address",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the ID of the corresponding public network",
- "name": "publicnetworkid",
- "type": "string"
- },
- {},
- {
- "description": "the account associated with the router",
- "name": "account",
+ "description": "the ID of the network",
+ "name": "networkid",
"type": "string"
},
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
+ }
+ ]
+ },
+ {
+ "description": "Scales a created, running or stopped Kubernetes cluster",
+ "isasync": true,
+ "name": "scaleKubernetesCluster",
+ "params": [
+ {
+ "description": "Maximum number of worker nodes in the cluster",
+ "length": 255,
+ "name": "maxsize",
+ "required": false,
+ "type": "long"
},
{
- "description": "the link local IP address for the router",
- "name": "linklocalip",
- "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 Pod name for the router",
- "name": "podname",
- "type": "string"
- },
- {
- "description": "true if any health checks had failed",
- "name": "healthchecksfailed",
+ "description": "Whether autoscaling is enabled for the cluster",
+ "length": 255,
+ "name": "autoscalingenabled",
+ "required": false,
"type": "boolean"
},
{
- "description": "the first IPv6 DNS for the router",
- "name": "ip6dns1",
+ "description": "the ID of the service offering for the virtual machines in the cluster.",
+ "length": 255,
+ "name": "serviceofferingid",
+ "related": "createServiceOffering,updateServiceOffering,listServiceOfferings",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "number of Kubernetes cluster nodes",
+ "length": 255,
+ "name": "size",
+ "required": false,
+ "type": "long"
+ },
+ {
+ "description": "the IDs of the nodes to be removed",
+ "length": 255,
+ "name": "nodeids",
+ "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance",
+ "required": false,
+ "type": "list"
+ },
+ {
+ "description": "Minimum number of worker nodes in the cluster",
+ "length": 255,
+ "name": "minsize",
+ "required": false,
+ "type": "long"
+ },
+ {
+ "description": "the ID of the Kubernetes cluster",
+ "length": 255,
+ "name": "id",
+ "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster",
+ "required": true,
+ "type": "uuid"
+ }
+ ],
+ "related": "createKubernetesCluster,startKubernetesCluster,upgradeKubernetesCluster",
+ "response": [
+ {
+ "description": "the memory the Kubernetes cluster",
+ "name": "memory",
"type": "string"
},
{
- "description": "the public IP address for the router",
- "name": "publicip",
+ "description": "the ID of the domain in which the Kubernetes cluster exists",
+ "name": "domainid",
"type": "string"
},
{
- "description": "the name of the service offering of the virtual machine",
- "name": "serviceofferingname",
- "type": "string"
- },
- {
- "description": "the project id of the ipaddress",
+ "description": "the project id of the Kubernetes cluster",
"name": "projectid",
"type": "string"
},
{
- "description": "if this router is an redundant virtual router",
- "name": "isredundantrouter",
- "type": "boolean"
- },
- {
- "description": "the state of redundant virtual router",
- "name": "redundantstate",
+ "description": "the name of the Kubernetes version for the Kubernetes cluster",
+ "name": "kubernetesversionname",
"type": "string"
},
{
- "description": "the public MAC address for the router",
- "name": "publicmacaddress",
+ "description": "the cpu cores of the Kubernetes cluster",
+ "name": "cpunumber",
"type": "string"
},
{
- "description": "the name of the corresponding guest network",
- "name": "guestnetworkname",
+ "description": "the ID of the service offering of the Kubernetes cluster",
+ "name": "serviceofferingid",
"type": "string"
},
{
- "description": "the version of template",
- "name": "version",
- "type": "string"
- },
- {
- "description": "the domain associated with the router",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the template ID for the router",
- "name": "templateid",
- "type": "string"
- },
- {
- "description": "true if the router template requires upgrader",
- "name": "requiresupgrade",
- "type": "boolean"
- },
- {
- "description": "the guest netmask for the router",
- "name": "guestnetmask",
- "type": "string"
- },
- {
- "description": "the second IPv6 DNS for the router",
- "name": "ip6dns2",
+ "description": "the name of the network of the Kubernetes cluster",
+ "name": "associatednetworkname",
"type": "string"
},
{
@@ -25652,138 +25888,301 @@
"type": "boolean"
},
{
- "description": "the link local netmask for the router",
- "name": "linklocalnetmask",
+ "description": "the name of the domain in which the Kubernetes cluster exists",
+ "name": "domain",
"type": "string"
},
{
- "description": "the network domain for the router",
- "name": "networkdomain",
+ "description": "URL end point for the Kubernetes cluster dashboard UI",
+ "name": "consoleendpoint",
"type": "string"
},
{
- "description": "the version of scripts",
- "name": "scriptsversion",
+ "description": "URL end point for the Kubernetes cluster",
+ "name": "endpoint",
"type": "string"
},
{
- "description": "the public netmask for the router",
- "name": "publicnetmask",
+ "description": "the ID of the template of the Kubernetes cluster",
+ "name": "templateid",
"type": "string"
},
{
- "description": "the name of VPC the router belongs to",
- "name": "vpcname",
+ "description": "the ID of the network of the Kubernetes cluster",
+ "name": "networkid",
"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": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "Whether autoscaling is enabled for the cluster",
+ "name": "autoscalingenabled",
+ "type": "boolean"
+ },
+ {
+ "description": "Maximum size of the cluster",
+ "name": "maxsize",
+ "type": "long"
+ },
+ {
+ "description": "the name of the zone of the Kubernetes cluster",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the id of the Kubernetes cluster",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the description of the Kubernetes cluster",
+ "name": "description",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the Kubernetes cluster",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the control nodes count for the Kubernetes cluster",
+ "name": "controlnodes",
+ "type": "long"
+ },
+ {
+ "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.",
+ "name": "masternodes",
+ "type": "long"
+ },
+ {
+ "description": "the project name of the Kubernetes cluster",
+ "name": "project",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "Public IP Address of the cluster",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "the list of virtualmachine associated with this Kubernetes cluster",
+ "name": "virtualmachines",
+ "type": "list"
+ },
+ {
+ "description": "the state of the Kubernetes cluster",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "keypair details",
+ "name": "keypair",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the Kubernetes cluster",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the name of the zone of the Kubernetes cluster",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "Public IP Address ID of the cluster",
+ "name": "ipaddressid",
+ "type": "string"
+ },
+ {
+ "description": "the size (worker nodes count) of the Kubernetes cluster",
+ "name": "size",
+ "type": "long"
+ },
+ {
+ "description": "the name of the service offering of the Kubernetes cluster",
+ "name": "serviceofferingname",
+ "type": "string"
+ },
+ {}
+ ]
+ },
+ {
+ "description": "Stops a NetScalervm.",
+ "isasync": true,
+ "name": "stopNetScalerVpx",
+ "params": [
+ {
+ "description": "the ID of the NetScaler vm",
+ "length": 255,
+ "name": "id",
+ "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx",
+ "required": true,
+ "type": "uuid"
+ },
+ {
+ "description": "Force stop the VM. The caller knows the VM is stopped.",
+ "length": 255,
+ "name": "forced",
+ "required": false,
+ "type": "boolean"
+ }
+ ],
+ "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs",
+ "response": [
+ {
+ "description": "the Zone name for the router",
+ "name": "zonename",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the state of the router",
+ "name": "state",
+ "type": "state"
+ },
+ {
+ "description": "the ID of the corresponding public network",
+ "name": "publicnetworkid",
+ "type": "string"
+ },
+ {
+ "description": "the public MAC address for the router",
+ "name": "publicmacaddress",
+ "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": "true if the router template requires upgrader",
+ "name": "requiresupgrade",
+ "type": "boolean"
+ },
+ {
+ "description": "the public IP address for the router",
+ "name": "publicip",
+ "type": "string"
+ },
+ {
+ "description": "the Pod ID for the router",
+ "name": "podid",
+ "type": "string"
+ },
+ {
+ "description": "the hypervisor on which the template runs",
+ "name": "hypervisor",
+ "type": "string"
+ },
+ {
+ "description": "the host ID for the router",
+ "name": "hostid",
+ "type": "string"
+ },
+ {
+ "description": "the project id of the ipaddress",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the guest MAC address for the router",
+ "name": "guestmacaddress",
+ "type": "string"
+ },
+ {
+ "description": "the hostname for the router",
+ "name": "hostname",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the corresponding guest network",
+ "name": "guestnetworkid",
+ "type": "string"
+ },
+ {
+ "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 date and time the router was created",
"name": "created",
"type": "date"
},
{
+ "description": "the domain associated with the router",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the id of the router",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "if this router is an redundant virtual router",
+ "name": "isredundantrouter",
+ "type": "boolean"
+ },
+ {
+ "description": "the gateway for the router",
+ "name": "gateway",
+ "type": "string"
+ },
+ {
"description": "the list of nics associated with the router",
"name": "nic",
"response": [
{
- "description": "the gateway of IPv6 network",
- "name": "ip6gateway",
- "type": "string"
- },
- {
- "description": "the extra dhcp options on the nic",
- "name": "extradhcpoption",
- "type": "list"
- },
- {
- "description": "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": "Type of adapter if available",
- "name": "adaptertype",
- "type": "string"
- },
- {
"description": "the isolated private VLAN type if available",
"name": "isolatedpvlantype",
"type": "string"
},
{
- "description": "the Secondary ipv4 addr of nic",
- "name": "secondaryip",
- "type": "list"
- },
- {
- "description": "the isolation uri of the nic",
- "name": "isolationuri",
- "type": "string"
- },
- {
- "description": "the isolated private VLAN if available",
- "name": "isolatedpvlan",
- "type": "integer"
- },
- {
- "description": "device id for the network when plugged into the virtual machine",
- "name": "deviceid",
- "type": "string"
- },
- {
- "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise",
- "name": "nsxlogicalswitchport",
- "type": "string"
- },
- {
- "description": "the netmask of the nic",
- "name": "netmask",
- "type": "string"
- },
- {
- "description": "the name of the corresponding network",
- "name": "networkname",
- "type": "string"
- },
- {
- "description": "the broadcast uri of the nic",
- "name": "broadcasturi",
- "type": "string"
- },
- {
"description": "true if nic is default, false otherwise",
"name": "macaddress",
"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 cidr of IPv6 network",
- "name": "ip6cidr",
- "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": "the gateway of the nic",
@@ -25791,13 +26190,33 @@
"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 ip address of the nic",
- "name": "ipaddress",
+ "description": "the netmask of the nic",
+ "name": "netmask",
+ "type": "string"
+ },
+ {
+ "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise",
+ "name": "nsxlogicalswitchport",
+ "type": "string"
+ },
+ {
+ "description": "the 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"
},
{
@@ -25806,31 +26225,217 @@
"type": "boolean"
},
{
- "description": "Id of the vm to which the nic belongs",
- "name": "virtualmachineid",
+ "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 type of the nic",
+ "name": "type",
+ "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": "the ip address of the nic",
+ "name": "ipaddress",
+ "type": "string"
}
],
"type": "set"
},
{
+ "description": "the ID of the corresponding link local network",
+ "name": "linklocalnetworkid",
+ "type": "string"
+ },
+ {
+ "description": "the template ID for the router",
+ "name": "templateid",
+ "type": "string"
+ },
+ {
+ "description": "the guest netmask for the router",
+ "name": "guestnetmask",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the router",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the name of VPC the router belongs to",
+ "name": "vpcname",
+ "type": "string"
+ },
+ {
+ "description": "the name of the service offering of the virtual machine",
+ "name": "serviceofferingname",
+ "type": "string"
+ },
+ {
"description": "role of the domain router",
"name": "role",
"type": "string"
},
{
+ "description": "the link local netmask for the router",
+ "name": "linklocalnetmask",
+ "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 project name of the address",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the first DNS for the router",
+ "name": "dns1",
+ "type": "string"
+ },
+ {
+ "description": "the version of scripts",
+ "name": "scriptsversion",
+ "type": "string"
+ },
+ {
"description": "the Zone ID for the router",
"name": "zoneid",
"type": "string"
},
{
- "description": "the first DNS for the router",
- "name": "dns1",
+ "description": "the name of the router",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the link local IP address for the router",
+ "name": "linklocalip",
+ "type": "string"
+ },
+ {
+ "description": "VPC the router belongs to",
+ "name": "vpcid",
+ "type": "string"
+ },
+ {
+ "description": "the second IPv6 DNS for the router",
+ "name": "ip6dns2",
+ "type": "string"
+ },
+ {
+ "description": "the name of the corresponding guest network",
+ "name": "guestnetworkname",
+ "type": "string"
+ },
+ {
+ "description": "the second DNS for the router",
+ "name": "dns2",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID associated with the router",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the network domain for the router",
+ "name": "networkdomain",
+ "type": "string"
+ },
+ {
+ "description": "the state of redundant virtual router",
+ "name": "redundantstate",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the template name for the router",
+ "name": "templatename",
+ "type": "string"
+ },
+ {
+ "description": "the Pod name for the router",
+ "name": "podname",
+ "type": "string"
+ },
+ {
+ "description": "the public netmask for the router",
+ "name": "publicnetmask",
"type": "string"
},
{
@@ -25843,92 +26448,32 @@
"name": "healthcheckresults",
"response": [
{
- "description": "detailed response generated on running health check",
- "name": "details",
+ "description": "the name of the health check on the router",
+ "name": "checkname",
"type": "string"
},
{
- "description": "the date this VPC was created",
- "name": "lastupdated",
- "type": "date"
- },
- {
"description": "the type of the health check - basic or advanced",
"name": "checktype",
"type": "string"
},
{
+ "description": "detailed response generated on running health check",
+ "name": "details",
+ "type": "string"
+ },
+ {
"description": "result of the health check",
"name": "success",
"type": "boolean"
},
{
- "description": "the name of the health check on the router",
- "name": "checkname",
- "type": "string"
+ "description": "the date this VPC was created",
+ "name": "lastupdated",
+ "type": "date"
}
],
"type": "list"
- },
- {
- "description": "the id of the router",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the name of the router",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the second DNS for the router",
- "name": "dns2",
- "type": "string"
- },
- {
- "description": "the guest IP address for the router",
- "name": "guestipaddress",
- "type": "string"
- },
- {
- "description": "the domain ID associated with the router",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the guest MAC address for the router",
- "name": "guestmacaddress",
- "type": "string"
- },
- {
- "description": "the host ID for the router",
- "name": "hostid",
- "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 Pod ID for the router",
- "name": "podid",
- "type": "string"
- },
- {
- "description": "the Zone name for the router",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "VPC the router belongs to",
- "name": "vpcid",
- "type": "string"
}
]
},
@@ -25947,28 +26492,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": "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"
- },
- {},
- {}
+ }
]
},
{
@@ -25977,12 +26522,11 @@
"name": "deleteHost",
"params": [
{
- "description": "the host ID",
+ "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": "id",
- "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost,listExternalLoadBalancers",
- "required": true,
- "type": "uuid"
+ "name": "forced",
+ "required": false,
+ "type": "boolean"
},
{
"description": "Force destroy local storage on this host. All VMs created on this local storage will be destroyed",
@@ -25992,15 +26536,26 @@
"type": "boolean"
},
{
- "description": "Force delete the host. All HA enabled vms running on the host will be put to HA; HA disabled ones will be stopped",
+ "description": "the host ID",
"length": 255,
- "name": "forced",
- "required": false,
- "type": "boolean"
+ "name": "id",
+ "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost,listExternalLoadBalancers",
+ "required": true,
+ "type": "uuid"
}
],
"response": [
{
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "true if operation is executed successfully",
+ "name": "success",
+ "type": "boolean"
+ },
+ {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
@@ -26010,17 +26565,7 @@
"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"
- },
{}
]
},
@@ -26040,11 +26585,10 @@
],
"response": [
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
},
- {},
{
"description": "any text associated with the success or failure",
"name": "displaytext",
@@ -26052,10 +26596,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",
+ "type": "integer"
},
+ {},
{
"description": "true if operation is executed successfully",
"name": "success",
@@ -26084,7 +26629,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",
@@ -26092,20 +26641,16 @@
},
{},
{
+ "description": "true if operation is executed successfully",
+ "name": "success",
+ "type": "boolean"
+ },
+ {
"description": "any text associated with the success or failure",
"name": "displaytext",
"type": "string"
},
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "true if operation is executed successfully",
- "name": "success",
- "type": "boolean"
- }
+ {}
],
"since": "4.16.0.0"
},
@@ -26117,85 +26662,18 @@
"related": "",
"response": [
{
- "description": "true if dynamic role-based api checker is enabled, false otherwise",
- "name": "dynamicrolesenabled",
- "type": "boolean"
- },
- {
"description": "true if region supports elastic load balancer on basic zones",
"name": "supportELB",
"type": "string"
},
{
- "description": "If invitation confirmation is required when add account to project",
- "name": "projectinviterequired",
- "type": "boolean"
- },
- {
- "description": "true if region wide secondary is enabled, false otherwise",
- "name": "regionsecondaryenabled",
- "type": "boolean"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "true if the user can recover and expunge volumes, false otherwise",
- "name": "allowuserexpungerecovervolume",
- "type": "boolean"
- },
- {
- "description": "true if users can see all accounts within the same domain, false otherwise",
- "name": "allowuserviewalldomainaccounts",
- "type": "boolean"
- },
- {
- "description": "true if security groups support is enabled, false otherwise",
- "name": "securitygroupsenabled",
- "type": "boolean"
- },
- {
- "description": "version of the cloud stack",
- "name": "cloudstackversion",
- "type": "string"
- },
- {
- "description": "default page size in the UI for various views, value set in the configurations",
- "name": "defaultuipagesize",
+ "description": "maximum size that can be specified when create disk from disk offering with custom size",
+ "name": "customdiskofferingmaxsize",
"type": "long"
},
{
- "description": "minimum size that can be specified when create disk from disk offering with custom size",
- "name": "customdiskofferingminsize",
- "type": "long"
- },
- {},
- {
- "description": "true if user and domain admins can set templates to be shared, false otherwise",
- "name": "userpublictemplateenabled",
- "type": "boolean"
- },
- {},
- {
- "description": "Max allowed number of api requests within the specified interval",
- "name": "apilimitmax",
- "type": "integer"
- },
- {
- "description": "true if experimental features for Kubernetes cluster such as Docker private registry are enabled, false otherwise",
- "name": "kubernetesclusterexperimentalfeaturesenabled",
- "type": "boolean"
- },
- {
- "description": "true if the user can recover and expunge virtualmachines, false otherwise",
- "name": "allowuserexpungerecovervm",
- "type": "boolean"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
+ "description": "time interval (in seconds) to reset api count",
+ "name": "apilimitinterval",
"type": "integer"
},
{
@@ -26204,13 +26682,18 @@
"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 region wide secondary is enabled, false otherwise",
+ "name": "regionsecondaryenabled",
+ "type": "boolean"
},
{
- "description": "true if Kubernetes Service plugin is enabled, false otherwise",
- "name": "kubernetesserviceenabled",
+ "description": "true if the user can recover and expunge virtualmachines, false otherwise",
+ "name": "allowuserexpungerecovervm",
+ "type": "boolean"
+ },
+ {
+ "description": "true if dynamic role-based api checker is enabled, false otherwise",
+ "name": "dynamicrolesenabled",
"type": "boolean"
},
{
@@ -26219,14 +26702,76 @@
"type": "boolean"
},
{
- "description": "time interval (in seconds) to reset api count",
- "name": "apilimitinterval",
+ "description": "default page size in the UI for various views, value set in the configurations",
+ "name": "defaultuipagesize",
+ "type": "long"
+ },
+ {
+ "description": "true if experimental features for Kubernetes cluster such as Docker private registry are enabled, false otherwise",
+ "name": "kubernetesclusterexperimentalfeaturesenabled",
+ "type": "boolean"
+ },
+ {
+ "description": "true if security groups support is enabled, false otherwise",
+ "name": "securitygroupsenabled",
+ "type": "boolean"
+ },
+ {},
+ {
+ "description": "true if the user can recover and expunge volumes, false otherwise",
+ "name": "allowuserexpungerecovervolume",
+ "type": "boolean"
+ },
+ {
+ "description": "minimum size that can be specified when create disk from disk offering with custom size",
+ "name": "customdiskofferingminsize",
+ "type": "long"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
"type": "integer"
},
{
+ "description": "If invitation confirmation is required when add account to project",
+ "name": "projectinviterequired",
+ "type": "boolean"
+ },
+ {
+ "description": "true if Kubernetes Service plugin is enabled, false otherwise",
+ "name": "kubernetesserviceenabled",
+ "type": "boolean"
+ },
+ {
+ "description": "version of the cloud stack",
+ "name": "cloudstackversion",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
"description": "true if snapshot is supported for KVM host, false otherwise",
"name": "kvmsnapshotenabled",
"type": "boolean"
+ },
+ {
+ "description": "true if user and domain admins can set templates to be shared, false otherwise",
+ "name": "userpublictemplateenabled",
+ "type": "boolean"
+ },
+ {
+ "description": "true if users can see all accounts within the same domain, false otherwise",
+ "name": "allowuserviewalldomainaccounts",
+ "type": "boolean"
+ },
+ {},
+ {
+ "description": "Max allowed number of api requests within the specified interval",
+ "name": "apilimitmax",
+ "type": "integer"
}
]
},
@@ -26236,6 +26781,13 @@
"name": "updateTrafficType",
"params": [
{
+ "description": "The network name label of the physical device dedicated to this traffic on a KVM host",
+ "length": 255,
+ "name": "kvmnetworklabel",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "The network name label of the physical device dedicated to this traffic on a Hyperv host",
"length": 255,
"name": "hypervnetworklabel",
@@ -26243,6 +26795,13 @@
"type": "string"
},
{
+ "description": "The network name label of the physical device dedicated to this traffic on a VMware host",
+ "length": 255,
+ "name": "vmwarenetworklabel",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "The network name of the physical device dedicated to this traffic on an OVM3 host",
"length": 255,
"name": "ovm3networklabel",
@@ -26258,57 +26817,21 @@
"type": "uuid"
},
{
- "description": "The network name label of the physical device dedicated to this traffic on a KVM host",
- "length": 255,
- "name": "kvmnetworklabel",
- "required": false,
- "type": "string"
- },
- {
"description": "The network name label of the physical device dedicated to this traffic on a XenServer host",
"length": 255,
"name": "xennetworklabel",
"required": false,
"type": "string"
- },
- {
- "description": "The network name label of the physical device dedicated to this traffic on a VMware host",
- "length": 255,
- "name": "vmwarenetworklabel",
- "required": false,
- "type": "string"
}
],
"related": "addTrafficType",
"response": [
{
- "description": "the trafficType to be added to the physical network",
- "name": "traffictype",
- "type": "string"
- },
- {
"description": "The network name label of the physical device dedicated to this traffic on a VMware host",
"name": "vmwarenetworklabel",
"type": "string"
},
{
- "description": "The network name label of the physical device dedicated to this traffic on a KVM host",
- "name": "kvmnetworklabel",
- "type": "string"
- },
- {},
- {},
- {
- "description": "The network name label of the physical device dedicated to this traffic on a XenServer host",
- "name": "xennetworklabel",
- "type": "string"
- },
- {
- "description": "the physical network this belongs to",
- "name": "physicalnetworkid",
- "type": "string"
- },
- {
"description": "id of the network provider",
"name": "id",
"type": "string"
@@ -26324,14 +26847,36 @@
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "The network name label of the physical device dedicated to this traffic on a KVM host",
+ "name": "kvmnetworklabel",
+ "type": "string"
+ },
+ {
+ "description": "the trafficType to be added to the physical network",
+ "name": "traffictype",
+ "type": "string"
+ },
+ {
+ "description": "the physical network this belongs to",
+ "name": "physicalnetworkid",
+ "type": "string"
},
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
+ },
+ {},
+ {
+ "description": "The network name label of the physical device dedicated to this traffic on a XenServer host",
+ "name": "xennetworklabel",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
}
],
"since": "3.0.0"
@@ -26352,27 +26897,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": "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"
- }
+ },
+ {},
+ {}
]
},
{
@@ -26381,6 +26926,51 @@
"name": "listConditions",
"params": [
{
+ "description": "ID of the Condition.",
+ "length": 255,
+ "name": "id",
+ "related": "createCondition,listConditions",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "Counter-id of the condition.",
+ "length": 255,
+ "name": "counterid",
+ "related": "createCounter,listCounters",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "the ID of the policy",
+ "length": 255,
+ "name": "policyid",
+ "related": "listAutoScalePolicies,updateAutoScalePolicy",
+ "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": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
+ "length": 255,
+ "name": "isrecursive",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "",
"length": 255,
"name": "page",
@@ -26396,20 +26986,6 @@
"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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false",
"length": 255,
"name": "listall",
@@ -26417,47 +26993,26 @@
"type": "boolean"
},
{
- "description": "ID of the Condition.",
- "length": 255,
- "name": "id",
- "related": "createCondition,listConditions",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
- },
- {
- "description": "the ID of the policy",
- "length": 255,
- "name": "policyid",
- "related": "listAutoScalePolicies,updateAutoScalePolicy",
- "required": false,
- "type": "uuid"
- },
- {
"description": "",
"length": 255,
"name": "pagesize",
"required": false,
"type": "integer"
- },
- {
- "description": "Counter-id of the condition.",
- "length": 255,
- "name": "counterid",
- "related": "createCounter,listCounters",
- "required": false,
- "type": "uuid"
}
],
"related": "createCondition",
"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 domain id of the Condition owner",
"name": "domainid",
"type": "string"
@@ -26469,39 +27024,13 @@
},
{},
{
- "description": "zone id of counter",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the domain name of the owner.",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "Relational Operator to be used with threshold.",
- "name": "relationaloperator",
- "type": "string"
- },
- {
"description": "the project name of the Condition",
"name": "project",
"type": "string"
},
- {},
{
- "description": "Details of the Counter.",
- "name": "counter",
- "type": "list"
- },
- {
- "description": "the id of the Condition",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the owner of the Condition.",
+ "name": "account",
"type": "string"
},
{
@@ -26509,14 +27038,30 @@
"name": "projectid",
"type": "string"
},
+ {},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "the domain name of the owner.",
+ "name": "domain",
+ "type": "string"
},
{
- "description": "the owner of the Condition.",
- "name": "account",
+ "description": "zone id of counter",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the id of the Condition",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "Details of the Counter.",
+ "name": "counter",
+ "type": "list"
+ },
+ {
+ "description": "Relational Operator to be used with threshold.",
+ "name": "relationaloperator",
"type": "string"
}
]
@@ -26527,11 +27072,12 @@
"name": "updateNetworkServiceProvider",
"params": [
{
- "description": "Enabled/Disabled/Shutdown the physical network service provider",
+ "description": "network service provider id",
"length": 255,
- "name": "state",
- "required": false,
- "type": "string"
+ "name": "id",
+ "related": "addNetworkServiceProvider,listNetworkServiceProviders,updateNetworkServiceProvider,listTrafficTypes",
+ "required": true,
+ "type": "uuid"
},
{
"description": "the list of services to be enabled for this physical network service provider",
@@ -26541,25 +27087,34 @@
"type": "list"
},
{
- "description": "network service provider id",
+ "description": "Enabled/Disabled/Shutdown the physical network service provider",
"length": 255,
- "name": "id",
- "related": "addNetworkServiceProvider,listNetworkServiceProviders,updateNetworkServiceProvider,listTrafficTypes",
- "required": true,
- "type": "uuid"
+ "name": "state",
+ "required": false,
+ "type": "string"
}
],
"related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes",
"response": [
- {},
+ {
+ "description": "state of the network provider",
+ "name": "state",
+ "type": "string"
+ },
{
"description": "the physical network this belongs to",
"name": "physicalnetworkid",
"type": "string"
},
{
- "description": "state of the network provider",
- "name": "state",
+ "description": "true if individual services can be enabled/disabled",
+ "name": "canenableindividualservice",
+ "type": "boolean"
+ },
+ {},
+ {
+ "description": "the provider name",
+ "name": "name",
"type": "string"
},
{},
@@ -26569,9 +27124,9 @@
"type": "string"
},
{
- "description": "true if individual services can be enabled/disabled",
- "name": "canenableindividualservice",
- "type": "boolean"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
{
"description": "uuid of the network provider",
@@ -26579,24 +27134,14 @@
"type": "string"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the provider name",
- "name": "name",
- "type": "string"
- },
- {
"description": "services for this provider",
"name": "servicelist",
"type": "list"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
}
],
"since": "3.0.0"
@@ -26615,33 +27160,34 @@
"type": "map"
},
{
- "description": "The ID of the load balancer rule",
- "length": 255,
- "name": "id",
- "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules",
- "required": true,
- "type": "uuid"
- },
- {
"description": "the list of IDs of the virtual machines that are being removed from the load balancer rule (i.e. virtualMachineIds=1,2,3)",
"length": 255,
"name": "virtualmachineids",
"related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance",
"required": false,
"type": "list"
+ },
+ {
+ "description": "The ID of the load balancer rule",
+ "length": 255,
+ "name": "id",
+ "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules",
+ "required": true,
+ "type": "uuid"
}
],
"response": [
+ {},
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
- {
- "description": "any text associated with the success or failure",
- "name": "displaytext",
- "type": "string"
- },
{},
{
"description": "true if operation is executed successfully",
@@ -26649,11 +27195,10 @@
"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"
- },
- {}
+ }
]
},
{
@@ -26662,21 +27207,6 @@
"name": "listInstanceGroups",
"params": [
{
- "description": "list objects by project",
- "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 by keyword",
"length": 255,
"name": "keyword",
@@ -26691,12 +27221,11 @@
"type": "integer"
},
{
- "description": "list instance groups by ID",
+ "description": "",
"length": 255,
- "name": "id",
- "related": "createInstanceGroup,listInstanceGroups,updateInstanceGroup",
+ "name": "page",
"required": false,
- "type": "uuid"
+ "type": "integer"
},
{
"description": "list only resources belonging to the domain specified",
@@ -26707,11 +27236,20 @@
"type": "uuid"
},
{
- "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false",
+ "description": "list objects by project",
"length": 255,
- "name": "listall",
+ "name": "projectid",
+ "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject",
"required": false,
- "type": "boolean"
+ "type": "uuid"
+ },
+ {
+ "description": "list instance groups by ID",
+ "length": 255,
+ "name": "id",
+ "related": "createInstanceGroup,listInstanceGroups,updateInstanceGroup",
+ "required": false,
+ "type": "uuid"
},
{
"description": "list instance groups by name",
@@ -26721,11 +27259,11 @@
"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",
"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.",
@@ -26733,19 +27271,30 @@
"name": "isrecursive",
"required": false,
"type": "boolean"
+ },
+ {
+ "description": "list resources by account. Must be used with the domainId parameter.",
+ "length": 255,
+ "name": "account",
+ "required": false,
+ "type": "string"
}
],
"related": "createInstanceGroup,updateInstanceGroup",
"response": [
{
- "description": "the ID of the instance group",
- "name": "id",
+ "description": "the domain ID of the instance group",
+ "name": "domainid",
"type": "string"
},
- {},
{
- "description": "the account owning the instance group",
- "name": "account",
+ "description": "the domain name of the instance group",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the name of the instance group",
+ "name": "name",
"type": "string"
},
{
@@ -26764,36 +27313,32 @@
"type": "boolean"
},
{
+ "description": "the project name of the instance group",
+ "name": "project",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the account owning the instance group",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the instance group",
+ "name": "id",
+ "type": "string"
+ },
+ {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
{
- "description": "the name of the instance group",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the domain ID of the instance group",
- "name": "domainid",
- "type": "string"
- },
- {
"description": "the project ID of the instance group",
"name": "projectid",
"type": "string"
},
- {},
- {
- "description": "the domain name of the instance group",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the project name of the instance group",
- "name": "project",
- "type": "string"
- }
+ {}
]
},
{
@@ -26802,14 +27347,6 @@
"name": "migrateSecondaryStorageData",
"params": [
{
- "description": "id(s) of the destination secondary storage pool(s) to which the templates are to be migrated",
- "length": 255,
- "name": "destpools",
- "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore",
- "required": true,
- "type": "list"
- },
- {
"description": "id of the image store from where the data is to be migrated",
"length": 255,
"name": "srcpool",
@@ -26818,6 +27355,14 @@
"type": "uuid"
},
{
+ "description": "id(s) of the destination secondary storage pool(s) to which the templates are to be migrated",
+ "length": 255,
+ "name": "destpools",
+ "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore",
+ "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",
@@ -26828,17 +27373,15 @@
"related": "",
"response": [
{
+ "description": "true if operation is executed successfully",
+ "name": "success",
+ "type": "boolean"
+ },
+ {
"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",
@@ -26849,11 +27392,13 @@
"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"
},
@@ -26863,48 +27408,93 @@
"name": "createStaticRoute",
"params": [
{
- "description": "static route cidr",
- "length": 255,
- "name": "cidr",
- "required": true,
- "type": "string"
- },
- {
"description": "the gateway id we are creating static route for",
"length": 255,
"name": "gatewayid",
"related": "createPrivateGateway",
"required": true,
"type": "uuid"
+ },
+ {
+ "description": "static route cidr",
+ "length": 255,
+ "name": "cidr",
+ "required": true,
+ "type": "string"
}
],
"related": "listStaticRoutes",
"response": [
{
- "description": "the ID of the domain associated with the static route",
- "name": "domainid",
+ "description": "the list of resource tags associated with static route",
+ "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 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": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ }
+ ],
+ "type": "list"
+ },
+ {
+ "description": "the state of the static route",
+ "name": "state",
"type": "string"
},
- {},
{
"description": "the project name of the static route",
"name": "project",
"type": "string"
},
{
- "description": "VPC gateway the route is created for",
- "name": "gatewayid",
- "type": "string"
- },
- {},
- {
- "description": "static route CIDR",
- "name": "cidr",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "VPC the static route belongs to",
+ "name": "vpcid",
"type": "string"
},
{
@@ -26917,68 +27507,7 @@
"name": "id",
"type": "string"
},
- {
- "description": "the state of the static route",
- "name": "state",
- "type": "string"
- },
- {
- "description": "the list of resource tags associated with static route",
- "name": "tags",
- "response": [
- {
- "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 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": "the account associated with the tag",
- "name": "account",
- "type": "string"
- }
- ],
- "type": "list"
- },
+ {},
{
"description": "the project id of the static route",
"name": "projectid",
@@ -26990,15 +27519,31 @@
"type": "string"
},
{
+ "description": "static route CIDR",
+ "name": "cidr",
+ "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": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
"description": "the domain associated with the static route",
"name": "domain",
"type": "string"
},
- {
- "description": "VPC the static route belongs to",
- "name": "vpcid",
- "type": "string"
- }
+ {}
]
},
{
@@ -27026,170 +27571,18 @@
"related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume",
"response": [
{
- "description": "the chain info of the volume",
- "name": "chaininfo",
+ "description": "cluster name where the volume is allocated",
+ "name": "clustername",
"type": "string"
},
{
- "description": "the disk utilization",
- "name": "utilization",
- "type": "string"
- },
- {
- "description": "id of the virtual machine",
- "name": "virtualmachineid",
- "type": "string"
- },
- {
- "description": "id of the primary storage hosting the disk volume; returned to admin user only",
- "name": "storageid",
- "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": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "bytes read rate of the disk volume",
- "name": "diskBytesReadRate",
- "type": "long"
- },
- {
- "description": "the display text of the service offering for root disk",
- "name": "serviceofferingdisplaytext",
- "type": "string"
- },
- {
- "description": "name of the disk volume",
- "name": "name",
- "type": "string"
- },
- {
- "description": "true if the volume is extractable, false otherwise",
- "name": "isextractable",
- "type": "boolean"
- },
- {
- "description": "the ID of the ISO attached to the virtual machine",
- "name": "isoid",
- "type": "string"
- },
- {
- "description": "pod name of the volume",
- "name": "podname",
- "type": "string"
- },
- {
- "description": "the read (io) of disk on the vm",
- "name": "diskioread",
- "type": "long"
- },
- {
"description": "name of the virtual machine",
"name": "vmname",
"type": "string"
},
{
- "description": "type of the disk volume (ROOT or DATADISK)",
- "name": "type",
- "type": "string"
- },
- {
- "description": "the account associated with the disk volume",
- "name": "account",
- "type": "string"
- },
- {},
- {
- "description": "the bytes actually consumed on disk",
- "name": "virtualsize",
- "type": "long"
- },
- {
- "description": "ID of the disk offering",
- "name": "diskofferingid",
- "type": "string"
- },
- {
- "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.",
- "name": "templateid",
- "type": "string"
- },
- {
- "description": "the path of the volume",
- "name": "path",
- "type": "string"
- },
- {
- "description": "provisioning type used to create volumes.",
- "name": "provisioningtype",
- "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": "name of the service offering for root disk",
- "name": "serviceofferingname",
- "type": "string"
- },
- {},
- {
- "description": "the name of the template for the virtual machine",
- "name": "templatename",
- "type": "string"
- },
- {
- "description": "true if storage snapshot is supported for the volume, false otherwise",
- "name": "supportsstoragesnapshot",
- "type": "boolean"
- },
- {
- "description": "Hypervisor the volume belongs to",
- "name": "hypervisor",
- "type": "string"
- },
- {
- "description": "size of the disk volume",
- "name": "size",
- "type": "long"
- },
- {
- "description": "ID of the availability zone",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the read (bytes) of disk on the vm",
- "name": "diskkbsread",
- "type": "long"
- },
- {
- "description": "ID of the snapshot from which this volume was created",
- "name": "snapshotid",
- "type": "string"
- },
- {
- "description": "display name of the virtual machine",
- "name": "vmdisplayname",
+ "description": "the name of the ISO attached to the virtual machine",
+ "name": "isoname",
"type": "string"
},
{
@@ -27198,30 +27591,156 @@
"type": "string"
},
{
+ "description": "state of the virtual machine",
+ "name": "vmstate",
+ "type": "string"
+ },
+ {
+ "description": "name of the disk volume",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "max iops of the disk volume",
+ "name": "maxiops",
+ "type": "long"
+ },
+ {
+ "description": "ID of the snapshot from which this volume was created",
+ "name": "snapshotid",
+ "type": "string"
+ },
+ {
+ "description": "ID of the disk volume",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the display text of the disk offering",
+ "name": "diskofferingdisplaytext",
+ "type": "string"
+ },
+ {
+ "description": "the path of the volume",
+ "name": "path",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the read (io) of disk on the vm",
+ "name": "diskioread",
+ "type": "long"
+ },
+ {
+ "description": "the bytes allocated",
+ "name": "physicalsize",
+ "type": "long"
+ },
+ {
+ "description": "the date the disk volume was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the read (bytes) of disk on the vm",
+ "name": "diskkbsread",
+ "type": "long"
+ },
+ {
+ "description": "io requests read rate of the disk volume per the disk offering",
+ "name": "diskIopsReadRate",
+ "type": "long"
+ },
+ {
+ "description": "the ID of the ISO attached to the virtual machine",
+ "name": "isoid",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the disk volume",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "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": "name of the disk offering",
+ "name": "diskofferingname",
+ "type": "string"
+ },
+ {
+ "description": "ID of the availability zone",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "an alternate display text of the ISO attached to the virtual machine",
+ "name": "isodisplaytext",
+ "type": "string"
+ },
+ {
+ "description": "ID of the service offering for root disk",
+ "name": "serviceofferingid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the ID of the domain associated with the disk volume",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "id of the virtual machine",
+ "name": "virtualmachineid",
+ "type": "string"
+ },
+ {
+ "description": "true if the volume is extractable, false otherwise",
+ "name": "isextractable",
+ "type": "boolean"
+ },
+ {
+ "description": "true if storage snapshot is supported for the volume, false otherwise",
+ "name": "supportsstoragesnapshot",
+ "type": "boolean"
+ },
+ {
+ "description": "bytes read rate of the disk volume",
+ "name": "diskBytesReadRate",
+ "type": "long"
+ },
+ {
+ "description": "the write (io) of disk on the vm",
+ "name": "diskiowrite",
+ "type": "long"
+ },
+ {
+ "description": "an optional field whether to the display the volume to the end user or not.",
+ "name": "displayvolume",
+ "type": "boolean"
+ },
+ {
+ "description": "the project id of the vpn",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
"description": "the list of resource tags associated",
"name": "tags",
"response": [
{
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "the project 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"
@@ -27232,13 +27751,18 @@
"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",
+ "description": "the project name where tag belongs to",
+ "name": "project",
"type": "string"
},
{
@@ -27247,151 +27771,36 @@
"type": "string"
},
{
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
"type": "string"
}
],
"type": "set"
},
{
- "description": "name of the primary storage hosting the disk volume",
- "name": "storage",
+ "description": "the chain info of the volume",
+ "name": "chaininfo",
"type": "string"
},
{
- "description": "the date the volume was attached to a VM instance",
- "name": "attached",
- "type": "date"
- },
- {
- "description": "max iops of the disk volume",
- "name": "maxiops",
- "type": "long"
- },
- {
- "description": "ID of the disk volume",
- "name": "id",
- "type": "string"
- },
- {
- "description": "need quiesce vm or not when taking snapshot",
- "name": "quiescevm",
- "type": "boolean"
- },
- {
- "description": "the bytes allocated",
- "name": "physicalsize",
- "type": "long"
- },
- {
- "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",
- "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": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the date the disk volume was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the display text of the disk offering",
- "name": "diskofferingdisplaytext",
- "type": "string"
- },
- {
- "description": "cluster id of the volume",
- "name": "clusterid",
- "type": "string"
- },
- {
- "description": "the name of the ISO attached to the virtual machine",
- "name": "isoname",
- "type": "string"
- },
- {
- "description": "the boolean state of whether the volume is destroyed or not",
- "name": "destroyed",
- "type": "boolean"
- },
- {
- "description": "the write (bytes) of disk on the vm",
- "name": "diskkbswrite",
- "type": "long"
- },
- {
- "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.",
- "name": "deviceid",
- "type": "long"
- },
- {
- "description": "state of the virtual machine",
- "name": "vmstate",
- "type": "string"
- },
- {
- "description": "name of the availability zone",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "the write (io) of disk on the vm",
- "name": "diskiowrite",
- "type": "long"
- },
- {
- "description": "min iops of the disk volume",
- "name": "miniops",
- "type": "long"
- },
- {
- "description": "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": " an alternate display text of the template for the virtual machine",
- "name": "templatedisplaytext",
- "type": "string"
- },
- {
- "description": "name of the disk offering",
- "name": "diskofferingname",
- "type": "string"
- },
- {
- "description": "the status of the volume",
- "name": "status",
+ "description": "type of the disk volume (ROOT or DATADISK)",
+ "name": "type",
"type": "string"
},
{
@@ -27400,14 +27809,150 @@
"type": "string"
},
{
- "description": "the project id of the vpn",
- "name": "projectid",
+ "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": "Hypervisor the volume belongs to",
+ "name": "hypervisor",
+ "type": "string"
+ },
+ {
+ "description": "the write (bytes) of disk on the vm",
+ "name": "diskkbswrite",
+ "type": "long"
+ },
+ {
+ "description": "id of the primary storage hosting the disk volume; returned to admin user only",
+ "name": "storageid",
"type": "string"
},
{
"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": " an alternate display text of the template for the virtual machine",
+ "name": "templatedisplaytext",
+ "type": "string"
+ },
+ {
+ "description": "need quiesce vm or not when taking snapshot",
+ "name": "quiescevm",
+ "type": "boolean"
+ },
+ {
+ "description": "ID of the disk offering",
+ "name": "diskofferingid",
+ "type": "string"
+ },
+ {
+ "description": "provisioning type used to create volumes.",
+ "name": "provisioningtype",
+ "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": "the bytes actually consumed on disk",
+ "name": "virtualsize",
+ "type": "long"
+ },
+ {
+ "description": "the state of the disk volume",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "the name of the template for the virtual machine",
+ "name": "templatename",
+ "type": "string"
+ },
+ {
+ "description": "size of the disk volume",
+ "name": "size",
+ "type": "long"
+ },
+ {
+ "description": "bytes write rate of the disk volume",
+ "name": "diskBytesWriteRate",
+ "type": "long"
+ },
+ {
+ "description": "io requests write rate of the disk volume per the disk offering",
+ "name": "diskIopsWriteRate",
+ "type": "long"
+ },
+ {
+ "description": "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": "name of the service offering for root disk",
+ "name": "serviceofferingname",
+ "type": "string"
+ },
+ {
+ "description": "display name of the virtual machine",
+ "name": "vmdisplayname",
+ "type": "string"
+ },
+ {
+ "description": "name of the availability zone",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.",
+ "name": "templateid",
+ "type": "string"
+ },
+ {
+ "description": "cluster id of the volume",
+ "name": "clusterid",
+ "type": "string"
+ },
+ {
+ "description": "the disk utilization",
+ "name": "utilization",
+ "type": "string"
+ },
+ {
+ "description": "min iops of the disk volume",
+ "name": "miniops",
+ "type": "long"
+ },
+ {},
+ {
+ "description": "the status of the volume",
+ "name": "status",
+ "type": "string"
}
],
"since": "4.14.0"
@@ -27418,20 +27963,6 @@
"name": "addTrafficType",
"params": [
{
- "description": "The VLAN id to be used for Management traffic by VMware host",
- "length": 255,
- "name": "vlan",
- "required": false,
- "type": "string"
- },
- {
- "description": "The network name of the physical device dedicated to this traffic on an OVM3 host",
- "length": 255,
- "name": "ovm3networklabel",
- "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'.",
"length": 255,
"name": "isolationmethod",
@@ -27439,13 +27970,6 @@
"type": "string"
},
{
- "description": "The network name label of the physical device dedicated to this traffic on a KVM host",
- "length": 255,
- "name": "kvmnetworklabel",
- "required": false,
- "type": "string"
- },
- {
"description": "the Physical Network ID",
"length": 255,
"name": "physicalnetworkid",
@@ -27454,13 +27978,6 @@
"type": "uuid"
},
{
- "description": "The network name label of the physical device dedicated to this traffic on a Hyperv host",
- "length": 255,
- "name": "hypervnetworklabel",
- "required": false,
- "type": "string"
- },
- {
"description": "The network name label of the physical device dedicated to this traffic on a VMware host",
"length": 255,
"name": "vmwarenetworklabel",
@@ -27468,6 +27985,13 @@
"type": "string"
},
{
+ "description": "The network name of the physical device dedicated to this traffic on an OVM3 host",
+ "length": 255,
+ "name": "ovm3networklabel",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "The network name label of the physical device dedicated to this traffic on a XenServer host",
"length": 255,
"name": "xennetworklabel",
@@ -27475,49 +27999,39 @@
"type": "string"
},
{
+ "description": "The VLAN id to be used for Management traffic by VMware host",
+ "length": 255,
+ "name": "vlan",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "The network name label of the physical device dedicated to this traffic on a KVM host",
+ "length": 255,
+ "name": "kvmnetworklabel",
+ "required": false,
+ "type": "string"
+ },
+ {
"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 Hyperv host",
+ "length": 255,
+ "name": "hypervnetworklabel",
+ "required": false,
+ "type": "string"
}
],
"related": "",
"response": [
- {},
{
- "description": "The network name of the physical device dedicated to this traffic on an OVM3 host",
- "name": "ovm3networklabel",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "The network name label of the physical device dedicated to this traffic on a XenServer host",
- "name": "xennetworklabel",
- "type": "string"
- },
- {
- "description": "id of the network provider",
- "name": "id",
- "type": "string"
- },
- {
- "description": "The network name label of the physical device dedicated to this traffic on a VMware host",
- "name": "vmwarenetworklabel",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the trafficType to be added to the physical network",
- "name": "traffictype",
+ "description": "the physical network this belongs to",
+ "name": "physicalnetworkid",
"type": "string"
},
{
@@ -27526,14 +28040,45 @@
"type": "string"
},
{
- "description": "the physical network this belongs to",
- "name": "physicalnetworkid",
+ "description": "the trafficType to be added to the physical network",
+ "name": "traffictype",
+ "type": "string"
+ },
+ {
+ "description": "id of the network provider",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "The network name label of the physical device dedicated to this traffic on a HyperV host",
+ "name": "hypervnetworklabel",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the 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 VMware host",
+ "name": "vmwarenetworklabel",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "The network name label of the physical device dedicated to this traffic on a XenServer host",
+ "name": "xennetworklabel",
+ "type": "string"
+ },
+ {
+ "description": "The network name of the physical device dedicated to this traffic on an OVM3 host",
+ "name": "ovm3networklabel",
"type": "string"
}
],
@@ -27555,15 +28100,9 @@
],
"response": [
{
- "description": "true if operation is executed successfully",
- "name": "success",
- "type": "boolean"
- },
- {},
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "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",
@@ -27571,10 +28110,16 @@
"type": "string"
},
{},
+ {},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "true if operation is executed successfully",
+ "name": "success",
+ "type": "boolean"
}
]
},
@@ -27584,13 +28129,6 @@
"name": "listLoadBalancerRuleInstances",
"params": [
{
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
- },
- {
"description": "",
"length": 255,
"name": "pagesize",
@@ -27598,6 +28136,13 @@
"type": "integer"
},
{
+ "description": "true if listing all virtual machines currently applied to the load balancer rule; default is true",
+ "length": 255,
+ "name": "applied",
+ "required": false,
+ "type": "boolean"
+ },
+ {
"description": "true if load balancer rule VM IP information to be included; default is false",
"length": 255,
"name": "lbvmips",
@@ -27605,6 +28150,13 @@
"type": "boolean"
},
{
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "the ID of the load balancer rule",
"length": 255,
"name": "id",
@@ -27618,22 +28170,17 @@
"name": "page",
"required": false,
"type": "integer"
- },
- {
- "description": "true if listing all virtual machines currently applied to the load balancer rule; default is true",
- "length": 255,
- "name": "applied",
- "required": false,
- "type": "boolean"
}
],
"related": "listLoadBalancerRuleInstances",
"response": [
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
+ "description": "the user vm set for lb rule",
+ "name": "loadbalancerruleinstance",
+ "type": "uservmresponse"
},
+ {},
+ {},
{
"description": "IP addresses of the vm set of lb rule",
"name": "lbvmipaddresses",
@@ -27644,13 +28191,11 @@
"name": "jobstatus",
"type": "integer"
},
- {},
{
- "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"
+ }
]
},
{
@@ -27669,27 +28214,27 @@
],
"response": [
{
- "description": "true if operation is executed successfully",
- "name": "success",
- "type": "boolean"
+ "description": "any text associated with the success or failure",
+ "name": "displaytext",
+ "type": "string"
},
+ {},
+ {},
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
{
- "description": "any text associated with the success or failure",
- "name": "displaytext",
- "type": "string"
+ "description": "true if operation is executed successfully",
+ "name": "success",
+ "type": "boolean"
},
- {},
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
- },
- {}
+ }
]
},
{
@@ -27698,6 +28243,13 @@
"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,
"name": "name",
@@ -27711,197 +28263,18 @@
"related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
"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",
"response": [
{
- "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 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",
- "type": "string"
- },
- {
- "description": "the total number of public ip addresses available for this domain to acquire",
- "name": "ipavailable",
- "type": "string"
- },
- {
- "description": "the total number of virtual machines available for this domain to acquire",
- "name": "vmavailable",
- "type": "string"
- },
- {
- "description": "the total volume being used by this domain",
- "name": "volumetotal",
- "type": "long"
- },
- {
- "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 number of public ip addresses this domain can acquire",
- "name": "iplimit",
- "type": "string"
- },
- {
- "description": "the ID of the domain",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the total number of snapshots stored by this domain",
- "name": "snapshottotal",
- "type": "long"
- },
- {
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "the total memory (in MB) owned by domain",
- "name": "memorytotal",
- "type": "long"
- },
- {
- "description": "the total number of templates which have been created by this domain",
- "name": "templatetotal",
- "type": "long"
- },
- {
- "description": "the total secondary storage space (in GiB) the domain can own",
- "name": "secondarystoragelimit",
- "type": "string"
- },
- {
- "description": "the total number of cpu cores owned by domain",
- "name": "cputotal",
- "type": "long"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the total volume available for this domain",
- "name": "volumeavailable",
- "type": "string"
- },
- {
- "description": "the state of the domain",
- "name": "state",
- "type": "string"
- },
- {
- "description": "the domain name of the parent domain",
- "name": "parentdomainname",
- "type": "string"
- },
- {
- "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",
- "name": "cpulimit",
- "type": "string"
- },
- {
- "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",
"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 deployed by this domain",
- "name": "vmtotal",
- "type": "long"
- },
- {
- "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 number of projects the domain can own",
- "name": "projectlimit",
- "type": "string"
- },
- {
- "description": "the total number of vpcs owned by domain",
- "name": "vpctotal",
- "type": "long"
- },
- {
- "description": "the domain ID of the parent domain",
- "name": "parentdomainid",
- "type": "string"
- },
- {
- "description": "the total number of networks the domain can own",
- "name": "networklimit",
- "type": "string"
- },
- {
- "description": "the total secondary storage space (in GiB) available to be used for this domain",
- "name": "secondarystorageavailable",
+ "description": "the total number of vpcs the domain can own",
+ "name": "vpclimit",
"type": "string"
},
{
@@ -27915,43 +28288,79 @@
"type": "string"
},
{
- "description": "the total number of projects available for administration by this domain",
- "name": "projectavailable",
+ "description": "the total number of networks the domain can own",
+ "name": "networklimit",
"type": "string"
},
{
- "description": "the total number of vpcs the domain can own",
- "name": "vpclimit",
+ "description": "the total number of projects being administrated by this domain",
+ "name": "projecttotal",
+ "type": "long"
+ },
+ {
+ "description": "the total 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 primary storage space (in GiB) available to be used for this domain",
- "name": "primarystorageavailable",
+ "description": "the total memory (in MB) available to be created for this domain",
+ "name": "memoryavailable",
"type": "string"
},
{
- "description": "the total volume which can be used by this domain",
- "name": "volumelimit",
+ "description": "the total secondary storage space (in GiB) available to be used for this domain",
+ "name": "secondarystorageavailable",
"type": "string"
},
{
- "description": "the path of the domain",
- "name": "path",
+ "description": "the total volume available for this domain",
+ "name": "volumeavailable",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "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 number of virtual machines available for this domain to acquire",
+ "name": "vmavailable",
"type": "string"
},
{
- "description": "the level of the domain",
- "name": "level",
- "type": "integer"
+ "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 number of cpu cores owned by domain",
+ "name": "cputotal",
+ "type": "long"
+ },
+ {
+ "description": "the domain ID of the parent domain",
+ "name": "parentdomainid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the total number of projects the domain can own",
+ "name": "projectlimit",
"type": "string"
},
{
@@ -27960,13 +28369,8 @@
"type": "resourceiconresponse"
},
{
- "description": "the total number of templates available to be created by this domain",
- "name": "templateavailable",
- "type": "string"
- },
- {
- "description": "the total primary storage space (in GiB) owned by domain",
- "name": "primarystoragetotal",
+ "description": "the total number of templates which have been created by this domain",
+ "name": "templatetotal",
"type": "long"
},
{
@@ -27975,9 +28379,150 @@
"type": "string"
},
{
+ "description": "the total secondary storage space (in GiB) owned by domain",
+ "name": "secondarystoragetotal",
+ "type": "float"
+ },
+ {
+ "description": "the total memory (in MB) owned by domain",
+ "name": "memorytotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of snapshots which can be stored by this domain",
+ "name": "snapshotlimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of virtual machines that can be deployed by this domain",
+ "name": "vmlimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of projects available for administration by this domain",
+ "name": "projectavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of snapshots stored by this domain",
+ "name": "snapshottotal",
+ "type": "long"
+ },
+ {
+ "description": "details for the domain",
+ "name": "domaindetails",
+ "type": "map"
+ },
+ {},
+ {
+ "description": "the total number of snapshots available for this domain",
+ "name": "snapshotavailable",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the path of the domain",
+ "name": "path",
+ "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 domain",
+ "name": "cpuavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of public ip addresses this domain can acquire",
+ "name": "iplimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of cpu cores the domain can own",
+ "name": "cpulimit",
+ "type": "string"
+ },
+ {
+ "description": "the level of the domain",
+ "name": "level",
+ "type": "integer"
+ },
+ {
+ "description": "the domain name of the parent domain",
+ "name": "parentdomainname",
+ "type": "string"
+ },
+ {
+ "description": "the total volume which can be used by this domain",
+ "name": "volumelimit",
+ "type": "string"
+ },
+ {
+ "description": "the state of the domain",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "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 date when this domain was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the total primary storage space (in GiB) the domain can own",
+ "name": "primarystoragelimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of templates which can be created by this domain",
+ "name": "templatelimit",
+ "type": "string"
+ },
+ {
+ "description": "the network domain",
+ "name": "networkdomain",
+ "type": "string"
+ },
+ {
+ "description": "the total number of templates available to be created by this domain",
+ "name": "templateavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total volume being used by this domain",
+ "name": "volumetotal",
+ "type": "long"
+ },
+ {
"description": "the total number of networks available to be created for this domain",
"name": "networkavailable",
"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) the domain can own",
+ "name": "secondarystoragelimit",
+ "type": "string"
}
]
},
@@ -27987,18 +28532,11 @@
"name": "updatePhysicalNetwork",
"params": [
{
- "description": "the VLAN for the physical network",
+ "description": "Tag the physical network",
"length": 255,
- "name": "vlan",
+ "name": "tags",
"required": false,
- "type": "string"
- },
- {
- "description": "Enabled/Disabled",
- "length": 255,
- "name": "state",
- "required": false,
- "type": "string"
+ "type": "list"
},
{
"description": "physical network id",
@@ -28009,43 +28547,50 @@
"type": "uuid"
},
{
+ "description": "Enabled/Disabled",
+ "length": 255,
+ "name": "state",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the VLAN for the physical network",
+ "length": 255,
+ "name": "vlan",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "the speed for the physical network[1G/10G]",
"length": 255,
"name": "networkspeed",
"required": false,
"type": "string"
- },
- {
- "description": "Tag the physical network",
- "length": 255,
- "name": "tags",
- "required": false,
- "type": "list"
}
],
"related": "createPhysicalNetwork",
"response": [
+ {},
{
"description": "zone name of the physical network",
"name": "zonename",
"type": "string"
},
{
+ "description": "state of the physical network",
+ "name": "state",
+ "type": "string"
+ },
+ {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "Broadcast domain range of the physical network",
- "name": "broadcastdomainrange",
+ "description": "the uuid of the physical network",
+ "name": "id",
"type": "string"
},
- {},
{
"description": "the speed of the physical network",
"name": "networkspeed",
@@ -28057,40 +28602,40 @@
"type": "string"
},
{
- "description": "zone id of the physical network",
- "name": "zoneid",
+ "description": "name of the physical network",
+ "name": "name",
"type": "string"
},
{},
{
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
"description": "comma separated tag",
"name": "tags",
"type": "string"
},
{
- "description": "name of the physical network",
- "name": "name",
+ "description": "Broadcast domain range of the physical network",
+ "name": "broadcastdomainrange",
"type": "string"
},
{
- "description": "state of the physical network",
- "name": "state",
- "type": "string"
- },
- {
- "description": "the uuid of the physical network",
- "name": "id",
- "type": "string"
- },
- {
- "description": "isolation methods",
- "name": "isolationmethods",
+ "description": "zone id of the physical network",
+ "name": "zoneid",
"type": "string"
},
{
"description": "the domain id of the physical network owner",
"name": "domainid",
"type": "string"
+ },
+ {
+ "description": "isolation methods",
+ "name": "isolationmethods",
+ "type": "string"
}
],
"since": "3.0.0"
@@ -28112,18 +28657,13 @@
"related": "enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup",
"response": [
{
- "description": "the frequency at which the conditions have to be evaluated",
- "name": "interval",
- "type": "int"
- },
- {
- "description": "the account owning the instance group",
- "name": "account",
+ "description": "the domain name of the vm profile",
+ "name": "domain",
"type": "string"
},
{
- "description": "the current state of the AutoScale Vm Group",
- "name": "state",
+ "description": "the autoscale vm group ID",
+ "name": "id",
"type": "string"
},
{
@@ -28132,44 +28672,33 @@
"type": "int"
},
{
- "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 project name of the vm profile",
- "name": "project",
- "type": "string"
- },
- {
- "description": "list of scaledown autoscale policies",
- "name": "scaledownpolicies",
- "type": "list"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
"description": "the project id vm profile",
"name": "projectid",
"type": "string"
},
{
- "description": "is group for display to the regular user",
- "name": "fordisplay",
- "type": "boolean"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
{
- "description": "list of scaleup autoscale policies",
- "name": "scaleuppolicies",
- "type": "list"
+ "description": "the account owning the instance group",
+ "name": "account",
+ "type": "string"
},
- {},
{
- "description": "the autoscale vm group ID",
- "name": "id",
+ "description": "the frequency at which the conditions have to be evaluated",
+ "name": "interval",
+ "type": "int"
+ },
+ {
+ "description": "the domain ID of the vm profile",
+ "name": "domainid",
"type": "string"
},
{
@@ -28178,24 +28707,40 @@
"type": "string"
},
{
+ "description": "the current state of the AutoScale Vm Group",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "is group for display to the regular user",
+ "name": "fordisplay",
+ "type": "boolean"
+ },
+ {},
+ {
"description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.",
"name": "minmembers",
"type": "int"
},
{
+ "description": "list of scaleup autoscale policies",
+ "name": "scaleuppolicies",
+ "type": "list"
+ },
+ {},
+ {
+ "description": "list of scaledown autoscale policies",
+ "name": "scaledownpolicies",
+ "type": "list"
+ },
+ {
"description": "the autoscale profile that contains information about the vms in the vm group.",
"name": "vmprofileid",
"type": "string"
},
{
- "description": "the domain name of the vm profile",
- "name": "domain",
- "type": "string"
- },
- {},
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the project name of the vm profile",
+ "name": "project",
"type": "string"
}
]
@@ -28206,21 +28751,6 @@
"name": "createSnapshotPolicy",
"params": [
{
- "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.",
- "length": 255,
- "name": "timezone",
- "required": true,
- "type": "string"
- },
- {
- "description": "an optional field, whether to the display the policy to the end user or not",
- "length": 255,
- "name": "fordisplay",
- "required": false,
- "since": "4.4",
- "type": "boolean"
- },
- {
"description": "time the snapshot is scheduled to be taken. Format is:* if HOURLY, MM* if DAILY, MM:HH* if WEEKLY, MM:HH:DD (1-7)* if MONTHLY, MM:HH:DD (1-28)",
"length": 255,
"name": "schedule",
@@ -28243,11 +28773,19 @@
"type": "uuid"
},
{
- "description": "Map of tags (key/value pairs)",
+ "description": "an optional field, whether to the display the policy to the end user or not",
"length": 255,
- "name": "tags",
+ "name": "fordisplay",
"required": false,
- "type": "map"
+ "since": "4.4",
+ "type": "boolean"
+ },
+ {
+ "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.",
+ "length": 255,
+ "name": "timezone",
+ "required": true,
+ "type": "string"
},
{
"description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY",
@@ -28255,74 +28793,55 @@
"name": "intervaltype",
"required": true,
"type": "string"
+ },
+ {
+ "description": "Map of tags (key/value pairs)",
+ "length": 255,
+ "name": "tags",
+ "required": false,
+ "type": "map"
}
],
"related": "updateSnapshotPolicy",
"response": [
{
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the ID of the snapshot policy",
+ "name": "id",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "is this policy for display to the regular user",
+ "name": "fordisplay",
+ "type": "boolean"
+ },
+ {
"description": "true if the entity/resource has annotations",
"name": "hasannotations",
"type": "boolean"
},
{
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
"description": "the interval type of the snapshot policy",
"name": "intervaltype",
"type": "short"
},
{
- "description": "the ID of the disk volume",
- "name": "volumeid",
- "type": "string"
- },
- {},
- {
- "description": "the time zone of the snapshot policy",
- "name": "timezone",
- "type": "string"
- },
- {
- "description": "maximum number of snapshots retained",
- "name": "maxsnaps",
- "type": "int"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {},
- {
- "description": "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 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": "tag key name",
- "name": "key",
+ "description": "customer associated with the tag",
+ "name": "customer",
"type": "string"
},
{
@@ -28331,13 +28850,18 @@
"type": "string"
},
{
- "description": "the account associated with the tag",
- "name": "account",
+ "description": "the project name where tag belongs to",
+ "name": "project",
"type": "string"
},
{
- "description": "the project name where tag belongs to",
- "name": "project",
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
"type": "string"
},
{
@@ -28346,28 +28870,49 @@
"type": "string"
},
{
- "description": "customer associated with the tag",
- "name": "customer",
+ "description": "resource type",
+ "name": "resourcetype",
"type": "string"
},
{
- "description": "resource type",
- "name": "resourcetype",
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
"type": "string"
},
{
"description": "the domain associated with the tag",
"name": "domain",
"type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
}
],
"type": "set"
},
{
- "description": "the ID of the snapshot policy",
- "name": "id",
+ "description": "maximum number of snapshots retained",
+ "name": "maxsnaps",
+ "type": "int"
+ },
+ {
+ "description": "the ID of the disk volume",
+ "name": "volumeid",
"type": "string"
- }
+ },
+ {
+ "description": "the time zone of the snapshot policy",
+ "name": "timezone",
+ "type": "string"
+ },
+ {
+ "description": "time the snapshot is scheduled to be taken.",
+ "name": "schedule",
+ "type": "string"
+ },
+ {}
]
},
{
@@ -28387,9 +28932,9 @@
"response": [
{},
{
- "description": "true if operation is executed successfully",
- "name": "success",
- "type": "boolean"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
{
"description": "the UUID of the latest async job acting on this object",
@@ -28397,15 +28942,15 @@
"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.11"
@@ -28416,50 +28961,6 @@
"name": "listSystemVms",
"params": [
{
- "description": "the system VM type. Possible types are \"consoleproxy\" and \"secondarystoragevm\".",
- "length": 255,
- "name": "systemvmtype",
- "required": false,
- "type": "string"
- },
- {
- "description": "",
- "length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
- },
- {
- "description": "the Zone ID of the system VM",
- "length": 255,
- "name": "zoneid",
- "related": "createZone,updateZone,listZones,listZones",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "",
- "length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
- },
- {
- "description": "the state of the system VM",
- "length": 255,
- "name": "state",
- "required": false,
- "type": "string"
- },
- {
- "description": "the host ID of the system VM",
- "length": 255,
- "name": "hostid",
- "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost,listExternalLoadBalancers",
- "required": false,
- "type": "uuid"
- },
- {
"description": "List by keyword",
"length": 255,
"name": "keyword",
@@ -28467,6 +28968,15 @@
"type": "string"
},
{
+ "description": "the storage ID where vm's volumes belong to",
+ "length": 255,
+ "name": "storageid",
+ "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities",
+ "required": false,
+ "since": "3.0.1",
+ "type": "uuid"
+ },
+ {
"description": "the Pod ID of the system VM",
"length": 255,
"name": "podid",
@@ -28490,202 +29000,60 @@
"type": "uuid"
},
{
- "description": "the storage ID where vm's volumes belong to",
+ "description": "the Zone ID of the system VM",
"length": 255,
- "name": "storageid",
- "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities",
+ "name": "zoneid",
+ "related": "createZone,updateZone,listZones,listZones",
"required": false,
- "since": "3.0.1",
+ "type": "uuid"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "the state of the system VM",
+ "length": 255,
+ "name": "state",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the system VM type. Possible types are \"consoleproxy\" and \"secondarystoragevm\".",
+ "length": 255,
+ "name": "systemvmtype",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the host ID of the system VM",
+ "length": 255,
+ "name": "hostid",
+ "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost,listExternalLoadBalancers",
+ "required": false,
"type": "uuid"
}
],
"related": "migrateSystemVm,startSystemVm,changeServiceForSystemVm",
"response": [
{
- "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 template name for the system VM",
- "name": "templatename",
- "type": "string"
- },
- {
- "description": "the host ID for the system VM",
- "name": "hostid",
- "type": "string"
- },
- {
- "description": "the public netmask for the system VM",
- "name": "publicnetmask",
- "type": "string"
- },
- {
- "description": "the template ID for the system VM",
- "name": "templateid",
- "type": "string"
- },
- {
- "description": "public vlan range",
- "name": "publicvlan",
- "type": "list"
- },
- {
- "description": "the link local netmask for the system vm",
- "name": "linklocalnetmask",
- "type": "string"
- },
- {
"description": "the hypervisor on which the template runs",
"name": "hypervisor",
"type": "string"
},
{
- "description": "the Pod name for the system VM",
- "name": "podname",
- "type": "string"
- },
- {
- "description": "the Zone name for the system VM",
- "name": "zonename",
- "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",
- "type": "string"
- },
- {
- "description": "the private MAC address for the system VM",
- "name": "privatemacaddress",
- "type": "string"
- },
- {
- "description": "the gateway for the system VM",
- "name": "gateway",
- "type": "string"
- },
- {
- "description": "guest vlan range",
- "name": "guestvlan",
- "type": "string"
- },
- {
- "description": "the public IP address for the system VM",
- "name": "publicip",
- "type": "string"
- },
- {
- "description": "the link local MAC address for the system vm",
- "name": "linklocalmacaddress",
- "type": "string"
- },
- {
- "description": "the name of the system VM",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the Pod ID for the system VM",
- "name": "podid",
- "type": "string"
- },
- {
- "description": "the link local IP address for the system vm",
- "name": "linklocalip",
- "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": "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 hostname for the system VM",
- "name": "hostname",
- "type": "string"
- },
- {
- "description": "the last disconnected date of host",
- "name": "disconnected",
- "type": "date"
- },
- {
- "description": "the date and time the system VM 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 first DNS for the system VM",
- "name": "dns1",
- "type": "string"
- },
- {
- "description": "the private IP address for the system VM",
- "name": "privateip",
- "type": "string"
- },
- {
- "description": "the network domain for the system VM",
- "name": "networkdomain",
- "type": "string"
- },
- {
- "description": "the system VM type",
- "name": "systemvmtype",
- "type": "string"
- },
- {
- "description": "the second DNS for the system VM",
- "name": "dns2",
- "type": "string"
- },
- {
- "description": "the private netmask for the system VM",
- "name": "privatenetmask",
- "type": "string"
- },
- {
- "description": "the Zone ID for the system VM",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the state of the system VM",
- "name": "state",
- "type": "string"
- },
- {},
- {},
- {
- "description": "the agent state of the system VM",
- "name": "agentstate",
+ "description": "the systemvm agent version",
+ "name": "version",
"type": "string"
},
{
@@ -28694,8 +29062,185 @@
"type": "boolean"
},
{
- "description": "the systemvm agent version",
- "name": "version",
+ "description": "the state of the system VM",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "the Pod ID for the system VM",
+ "name": "podid",
+ "type": "string"
+ },
+ {
+ "description": "the first DNS for the system VM",
+ "name": "dns1",
+ "type": "string"
+ },
+ {
+ "description": "the private MAC address for the system VM",
+ "name": "privatemacaddress",
+ "type": "string"
+ },
+ {
+ "description": "the last disconnected date of host",
+ "name": "disconnected",
+ "type": "date"
+ },
+ {
+ "description": "the agent state of the system VM",
+ "name": "agentstate",
+ "type": "string"
+ },
+ {
+ "description": "the 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": "public vlan range",
+ "name": "publicvlan",
+ "type": "list"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the host ID for the system VM",
+ "name": "hostid",
+ "type": "string"
+ },
+ {
+ "description": "the date and time the system VM was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the private netmask for the system VM",
+ "name": "privatenetmask",
+ "type": "string"
+ },
+ {
+ "description": "the name of the system VM",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the number of active console sessions for the console proxy system vm",
+ "name": "activeviewersessions",
+ "type": "integer"
+ },
+ {
+ "description": "guest vlan range",
+ "name": "guestvlan",
+ "type": "string"
+ },
+ {
+ "description": "the Pod name for the system VM",
+ "name": "podname",
+ "type": "string"
+ },
+ {
+ "description": "the public netmask for the system VM",
+ "name": "publicnetmask",
+ "type": "string"
+ },
+ {
+ "description": "the link local IP address for the system vm",
+ "name": "linklocalip",
+ "type": "string"
+ },
+ {
+ "description": "the second DNS for the system VM",
+ "name": "dns2",
+ "type": "string"
+ },
+ {
+ "description": "the link local MAC address for the system vm",
+ "name": "linklocalmacaddress",
+ "type": "string"
+ },
+ {
+ "description": "the network domain for the system VM",
+ "name": "networkdomain",
+ "type": "string"
+ },
+ {
+ "description": "the public IP address for the system VM",
+ "name": "publicip",
+ "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 gateway for the system VM",
+ "name": "gateway",
+ "type": "string"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {},
+ {},
+ {
+ "description": "the public MAC address for the system VM",
+ "name": "publicmacaddress",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the system VM",
+ "name": "id",
+ "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 template ID for the system VM",
+ "name": "templateid",
+ "type": "string"
+ },
+ {
+ "description": "the link local netmask for the system vm",
+ "name": "linklocalnetmask",
+ "type": "string"
+ },
+ {
+ "description": "the Zone name for the system VM",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "the Zone ID for the system VM",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the template name for the system VM",
+ "name": "templatename",
+ "type": "string"
+ },
+ {
+ "description": "the private IP address for the system VM",
+ "name": "privateip",
+ "type": "string"
+ },
+ {
+ "description": "the hostname for the system VM",
+ "name": "hostname",
"type": "string"
}
]
@@ -28706,13 +29251,6 @@
"name": "createRolePermission",
"params": [
{
- "description": "The API name or wildcard rule such as list*",
- "length": 255,
- "name": "rule",
- "required": true,
- "type": "string"
- },
- {
"description": "ID of the role",
"length": 255,
"name": "roleid",
@@ -28728,6 +29266,13 @@
"type": "string"
},
{
+ "description": "The API name or wildcard rule such as list*",
+ "length": 255,
+ "name": "rule",
+ "required": true,
+ "type": "string"
+ },
+ {
"description": "The rule permission, allow or deny. Default: deny.",
"length": 255,
"name": "permission",
@@ -28737,27 +29282,16 @@
],
"related": "listRolePermissions",
"response": [
- {},
{
- "description": "the ID of the role permission",
- "name": "id",
+ "description": "the permission type of the api name or wildcard rule, allow/deny",
+ "name": "permission",
"type": "string"
},
{
- "description": "the description of the role permission",
- "name": "description",
+ "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"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
{},
{
"description": "the name of the role to which the role permission belongs",
@@ -28770,13 +29304,24 @@
"type": "string"
},
{
- "description": "the api name or wildcard rule",
- "name": "rule",
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the ID of the role permission",
+ "name": "id",
"type": "string"
},
{
- "description": "the permission type of the api name or wildcard rule, allow/deny",
- "name": "permission",
+ "description": "the description of the role permission",
+ "name": "description",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
}
],
@@ -28788,6 +29333,15 @@
"name": "createProject",
"params": [
{
+ "description": "user ID of the account to be assigned as owner of the project i.e., Project Admin",
+ "length": 255,
+ "name": "userid",
+ "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser",
+ "required": false,
+ "since": "4.15.0",
+ "type": "uuid"
+ },
+ {
"description": "account who will be Admin for the project",
"length": 255,
"name": "account",
@@ -28795,12 +29349,11 @@
"type": "string"
},
{
- "description": "user ID of the account to be assigned as owner of the project i.e., Project Admin",
+ "description": "domain ID of the account owning a project",
"length": 255,
- "name": "userid",
- "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser",
+ "name": "domainid",
+ "related": "createDomain,listDomainChildren,listDomains,listDomains",
"required": false,
- "since": "4.15.0",
"type": "uuid"
},
{
@@ -28819,14 +29372,6 @@
"type": "string"
},
{
- "description": "domain ID of the account owning a project",
- "length": 255,
- "name": "domainid",
- "related": "createDomain,listDomainChildren,listDomains,listDomains",
- "required": false,
- "type": "uuid"
- },
- {
"description": "display text of the project",
"length": 255,
"name": "displaytext",
@@ -28837,129 +29382,23 @@
"related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject",
"response": [
{
- "description": "the total volume which can be used by this project",
- "name": "volumelimit",
- "type": "string"
- },
- {
- "description": "the total memory (in MB) the project can own",
- "name": "memorylimit",
- "type": "string"
- },
- {
- "description": "the total number of networks the project can own",
- "name": "networklimit",
- "type": "string"
- },
- {
- "description": "the total number of vpcs owned by project",
- "name": "vpctotal",
- "type": "long"
- },
- {
- "description": "the date this project was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the total volume being used by this project",
- "name": "volumetotal",
- "type": "long"
- },
- {
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
- },
- {},
- {
- "description": "the total number of snapshots which can be stored by this project",
- "name": "snapshotlimit",
- "type": "string"
- },
- {
- "description": "the id of the project",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the total primary storage space (in GiB) the project can own",
- "name": "primarystoragelimit",
- "type": "string"
- },
- {
- "description": "the account name of the project's owners",
- "name": "owner",
- "type": "list"
- },
- {
- "description": "the total number of templates available to be created by this project",
- "name": "templateavailable",
- "type": "string"
- },
- {
- "description": "the total number of networks owned by project",
- "name": "networktotal",
- "type": "long"
- },
- {
"description": "the total secondary storage space (in GiB) available to be used for this project",
"name": "secondarystorageavailable",
"type": "string"
},
{
- "description": "the total number of public ip addresses this project can acquire",
- "name": "iplimit",
- "type": "string"
- },
- {
- "description": "the project account name of the project",
- "name": "projectaccountname",
- "type": "string"
- },
- {
"description": "the total primary storage space (in GiB) available to be used for this project",
"name": "primarystorageavailable",
"type": "string"
},
{
- "description": "the displaytext of the project",
- "name": "displaytext",
+ "description": "the total number of virtual machines available for this project to acquire",
+ "name": "vmavailable",
"type": "string"
},
{
- "description": "the total secondary storage space (in GiB) the project can own",
- "name": "secondarystoragelimit",
- "type": "string"
- },
- {
- "description": "the name of the project",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the total memory (in MB) owned by project",
- "name": "memorytotal",
- "type": "long"
- },
- {
- "description": "the total number of cpu cores available to be created for this project",
- "name": "cpuavailable",
- "type": "string"
- },
- {
- "description": "the total number of snapshots stored by this project",
- "name": "snapshottotal",
- "type": "long"
- },
- {
- "description": "the state of the project",
- "name": "state",
+ "description": "the total number of vpcs available to be created for this project",
+ "name": "vpcavailable",
"type": "string"
},
{
@@ -28968,27 +29407,32 @@
"type": "string"
},
{
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
"description": "the list of resource tags associated with vm",
"name": "tags",
"response": [
{
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
"description": "the account associated with the tag",
"name": "account",
"type": "string"
},
{
- "description": "tag value",
- "name": "value",
+ "description": "resource type",
+ "name": "resourcetype",
"type": "string"
},
{
- "description": "resource type",
- "name": "resourcetype",
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
"type": "string"
},
{
@@ -29002,18 +29446,18 @@
"type": "string"
},
{
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
"description": "the project id the tag belongs to",
"name": "projectid",
"type": "string"
},
{
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "the project name where tag belongs to",
- "name": "project",
+ "description": "tag value",
+ "name": "value",
"type": "string"
},
{
@@ -29025,73 +29469,23 @@
"type": "list"
},
{
- "description": "the total number of cpu cores owned by project",
- "name": "cputotal",
- "type": "long"
- },
- {
- "description": "the total secondary storage space (in GiB) owned by project",
- "name": "secondarystoragetotal",
- "type": "float"
- },
- {
- "description": "the total number of public ip addresses available for this project to acquire",
- "name": "ipavailable",
+ "description": "the total number of templates which can be created by this project",
+ "name": "templatelimit",
"type": "string"
},
{
- "description": "the total number of 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 total memory (in MB) available to be created for this project",
- "name": "memoryavailable",
- "type": "string"
- },
- {
- "description": "the total number of cpu cores the project can own",
- "name": "cpulimit",
- "type": "string"
- },
- {
- "description": "the total number of snapshots available for this project",
- "name": "snapshotavailable",
- "type": "string"
- },
- {
- "description": "the total number of virtual machines stopped for this project",
- "name": "vmstopped",
- "type": "integer"
- },
- {
"description": "the total primary storage space (in GiB) owned by project",
"name": "primarystoragetotal",
"type": "long"
},
{
- "description": "the total number of virtual machines that can be deployed by this project",
- "name": "vmlimit",
+ "description": "the name of the project",
+ "name": "name",
"type": "string"
},
{
- "description": "the domain id the project belongs to",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the total number of public ip addresses allocated for this project",
- "name": "iptotal",
- "type": "long"
- },
- {
- "description": "the domain name where the project belongs to",
- "name": "domain",
+ "description": "the total volume which can be used by this project",
+ "name": "volumelimit",
"type": "string"
},
{
@@ -29100,8 +29494,8 @@
"type": "long"
},
{
- "description": "the total number of virtual machines available for this project to acquire",
- "name": "vmavailable",
+ "description": "the total memory (in MB) available to be created for this project",
+ "name": "memoryavailable",
"type": "string"
},
{
@@ -29110,24 +29504,175 @@
"type": "integer"
},
{
- "description": "the total number of vpcs the project can own",
- "name": "vpclimit",
+ "description": "the total number of snapshots which can be stored by this project",
+ "name": "snapshotlimit",
"type": "string"
},
+ {},
+ {
+ "description": "the total number of virtual machines stopped for this project",
+ "name": "vmstopped",
+ "type": "integer"
+ },
+ {
+ "description": "the date this project was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the total number of networks owned by project",
+ "name": "networktotal",
+ "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",
+ "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 project",
+ "name": "vpctotal",
+ "type": "long"
+ },
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
- {},
{
- "description": "the total number of vpcs available to be created for this project",
- "name": "vpcavailable",
+ "description": "the total memory (in MB) owned by project",
+ "name": "memorytotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of public ip addresses allocated for this project",
+ "name": "iptotal",
+ "type": "long"
+ },
+ {
+ "description": "the total primary storage space (in GiB) the project can own",
+ "name": "primarystoragelimit",
"type": "string"
},
{
- "description": "the total number of templates which can be created by this project",
- "name": "templatelimit",
+ "description": "the total number of networks the project can own",
+ "name": "networklimit",
+ "type": "string"
+ },
+ {
+ "description": "the state of the project",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "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",
+ "type": "string"
+ },
+ {
+ "description": "the account name of the project's owners",
+ "name": "owner",
+ "type": "list"
+ },
+ {
+ "description": "the total secondary storage space (in GiB) owned by project",
+ "name": "secondarystoragetotal",
+ "type": "float"
+ },
+ {},
+ {
+ "description": "the total number of cpu cores the project can own",
+ "name": "cpulimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of templates which have been created by this project",
+ "name": "templatetotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of templates available to be created by this project",
+ "name": "templateavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of virtual machines that can be deployed by this project",
+ "name": "vmlimit",
+ "type": "string"
+ },
+ {
+ "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 owned by project",
+ "name": "cputotal",
+ "type": "long"
+ },
+ {
+ "description": "the domain id the project belongs to",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the id of the project",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the total number of vpcs the project can own",
+ "name": "vpclimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of snapshots available for this project",
+ "name": "snapshotavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total volume being used by this project",
+ "name": "volumetotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of snapshots stored by this project",
+ "name": "snapshottotal",
+ "type": "long"
+ },
+ {
+ "description": "the total memory (in MB) the project can own",
+ "name": "memorylimit",
+ "type": "string"
+ },
+ {
+ "description": "the total secondary storage space (in GiB) the project can own",
+ "name": "secondarystoragelimit",
+ "type": "string"
+ },
+ {
+ "description": "the domain name where the project belongs to",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the total volume available for this project",
+ "name": "volumeavailable",
"type": "string"
}
],
@@ -29157,26 +29702,26 @@
],
"response": [
{
- "description": "true if operation is executed successfully",
- "name": "success",
- "type": "boolean"
+ "description": "any text associated with the success or failure",
+ "name": "displaytext",
+ "type": "string"
},
- {},
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
+ {
+ "description": "true if operation is executed successfully",
+ "name": "success",
+ "type": "boolean"
+ },
+ {},
{},
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
- },
- {
- "description": "any text associated with the success or failure",
- "name": "displaytext",
- "type": "string"
}
]
},
@@ -29186,6 +29731,13 @@
"name": "addCiscoVnmcResource",
"params": [
{
+ "description": "Hostname or ip address of the Cisco VNMC Controller.",
+ "length": 255,
+ "name": "hostname",
+ "required": true,
+ "type": "string"
+ },
+ {
"description": "the Physical Network ID",
"length": 255,
"name": "physicalnetworkid",
@@ -29206,18 +29758,18 @@
"name": "username",
"required": true,
"type": "string"
- },
- {
- "description": "Hostname or ip address of the Cisco VNMC Controller.",
- "length": 255,
- "name": "hostname",
- "required": true,
- "type": "string"
}
],
"related": "listCiscoVnmcResources",
"response": [
{},
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {},
+ {},
{},
{},
{},
@@ -29226,13 +29778,6 @@
"name": "jobstatus",
"type": "integer"
},
- {},
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {},
{}
]
},
@@ -29268,229 +29813,11 @@
"related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume",
"response": [
{
- "description": "the ID of the ISO attached to the virtual machine",
- "name": "isoid",
- "type": "string"
- },
- {
- "description": "the boolean state of whether the volume is destroyed or not",
- "name": "destroyed",
- "type": "boolean"
- },
- {
- "description": "the bytes allocated",
- "name": "physicalsize",
- "type": "long"
- },
- {
- "description": "id of the primary storage hosting the disk volume; returned to admin user only",
- "name": "storageid",
- "type": "string"
- },
- {
- "description": "the name of the template for the virtual machine",
- "name": "templatename",
- "type": "string"
- },
- {
- "description": "the disk utilization",
- "name": "utilization",
- "type": "string"
- },
- {
- "description": "the write (bytes) of disk on the vm",
- "name": "diskkbswrite",
- "type": "long"
- },
- {
"description": "size of the disk volume",
"name": "size",
"type": "long"
},
{
- "description": "min iops of the disk volume",
- "name": "miniops",
- "type": "long"
- },
- {},
- {
- "description": "the read (bytes) of disk on the vm",
- "name": "diskkbsread",
- "type": "long"
- },
- {
- "description": "the domain associated with the disk volume",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the list of resource tags associated",
- "name": "tags",
- "response": [
- {
- "description": "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": "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 value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "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": "bytes read rate of the disk volume",
- "name": "diskBytesReadRate",
- "type": "long"
- },
- {
- "description": "the account associated with the disk volume",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the read (io) of disk on the vm",
- "name": "diskioread",
- "type": "long"
- },
- {
- "description": "the write (io) of disk on the vm",
- "name": "diskiowrite",
- "type": "long"
- },
- {
- "description": "type of the disk volume (ROOT or DATADISK)",
- "name": "type",
- "type": "string"
- },
- {
- "description": "state of the virtual machine",
- "name": "vmstate",
- "type": "string"
- },
- {
- "description": "true if the volume is extractable, false otherwise",
- "name": "isextractable",
- "type": "boolean"
- },
- {
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "max iops of the disk volume",
- "name": "maxiops",
- "type": "long"
- },
- {
- "description": "io requests read rate of the disk volume per the disk offering",
- "name": "diskIopsReadRate",
- "type": "long"
- },
- {
- "description": "name of the disk offering",
- "name": "diskofferingname",
- "type": "string"
- },
- {
- "description": "name of the virtual machine",
- "name": "vmname",
- "type": "string"
- },
- {
- "description": "name of the availability zone",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "the project id of the vpn",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": " an alternate display text of the template for the virtual machine",
- "name": "templatedisplaytext",
- "type": "string"
- },
- {
- "description": "ID of the availability zone",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "provisioning type used to create volumes.",
- "name": "provisioningtype",
- "type": "string"
- },
- {
- "description": "the bytes actually consumed on disk",
- "name": "virtualsize",
- "type": "long"
- },
- {
- "description": "an alternate display text of the ISO attached to the virtual machine",
- "name": "isodisplaytext",
- "type": "string"
- },
- {
- "description": "ID of the snapshot from which this volume was created",
- "name": "snapshotid",
- "type": "string"
- },
- {
"description": "pod name of the volume",
"name": "podname",
"type": "string"
@@ -29501,9 +29828,19 @@
"type": "string"
},
{
- "description": "the date the disk volume was created",
- "name": "created",
- "type": "date"
+ "description": "bytes write rate of the disk volume",
+ "name": "diskBytesWriteRate",
+ "type": "long"
+ },
+ {
+ "description": "pod id of the volume",
+ "name": "podid",
+ "type": "string"
+ },
+ {
+ "description": "an alternate display text of the ISO attached to the virtual machine",
+ "name": "isodisplaytext",
+ "type": "string"
},
{
"description": "shared or local storage",
@@ -29511,8 +29848,53 @@
"type": "string"
},
{
- "description": "the status of the volume",
- "name": "status",
+ "description": "the name of the ISO attached to the virtual machine",
+ "name": "isoname",
+ "type": "string"
+ },
+ {
+ "description": "the write (io) of disk on the vm",
+ "name": "diskiowrite",
+ "type": "long"
+ },
+ {
+ "description": "the date the disk volume was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "provisioning type used to create volumes.",
+ "name": "provisioningtype",
+ "type": "string"
+ },
+ {
+ "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": "the display text of the disk offering",
+ "name": "diskofferingdisplaytext",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "state of the virtual machine",
+ "name": "vmstate",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the disk volume",
+ "name": "account",
"type": "string"
},
{
@@ -29521,6 +29903,36 @@
"type": "string"
},
{
+ "description": "the boolean state of whether the volume is destroyed or not",
+ "name": "destroyed",
+ "type": "boolean"
+ },
+ {
+ "description": "ID of the availability zone",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "id of the virtual machine",
+ "name": "virtualmachineid",
+ "type": "string"
+ },
+ {
+ "description": "the disk utilization",
+ "name": "utilization",
+ "type": "string"
+ },
+ {
+ "description": "io requests read rate of the disk volume per the disk offering",
+ "name": "diskIopsReadRate",
+ "type": "long"
+ },
+ {
+ "description": "min iops of the disk volume",
+ "name": "miniops",
+ "type": "long"
+ },
+ {
"description": "io requests write rate of the disk volume per the disk offering",
"name": "diskIopsWriteRate",
"type": "long"
@@ -29531,59 +29943,29 @@
"type": "boolean"
},
{
- "description": "bytes write rate of the disk volume",
- "name": "diskBytesWriteRate",
+ "description": "bytes read rate of the disk volume",
+ "name": "diskBytesReadRate",
"type": "long"
},
{
- "description": "ID of the disk offering",
- "name": "diskofferingid",
- "type": "string"
- },
- {
- "description": "cluster id of the volume",
- "name": "clusterid",
- "type": "string"
- },
- {
- "description": "name of the primary storage hosting the disk volume",
- "name": "storage",
- "type": "string"
- },
- {
- "description": "an optional field whether to the display the volume to the end user or not.",
- "name": "displayvolume",
+ "description": "true if the volume is extractable, false otherwise",
+ "name": "isextractable",
"type": "boolean"
},
{
- "description": "the display text of the service offering for root disk",
- "name": "serviceofferingdisplaytext",
+ "description": "type of the disk volume (ROOT or DATADISK)",
+ "name": "type",
+ "type": "string"
+ },
+ {
+ "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": "id of the virtual machine",
- "name": "virtualmachineid",
- "type": "string"
- },
- {
- "description": "name of the disk volume",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the date the volume was attached to a VM instance",
- "name": "attached",
- "type": "date"
- },
- {
- "description": "ID of the service offering for root disk",
- "name": "serviceofferingid",
+ "description": "the name of the template for the virtual machine",
+ "name": "templatename",
"type": "string"
},
{
@@ -29592,49 +29974,121 @@
"type": "boolean"
},
{
+ "description": "Hypervisor the volume belongs to",
+ "name": "hypervisor",
+ "type": "string"
+ },
+ {
+ "description": "the read (io) of disk on the vm",
+ "name": "diskioread",
+ "type": "long"
+ },
+ {
+ "description": "the list of resource tags associated",
+ "name": "tags",
+ "response": [
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "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": "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": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the project id of the vpn",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
"description": "the chain info of the volume",
"name": "chaininfo",
"type": "string"
},
{
+ "description": "the bytes allocated",
+ "name": "physicalsize",
+ "type": "long"
+ },
+ {
+ "description": "the date the volume was attached to a VM instance",
+ "name": "attached",
+ "type": "date"
+ },
+ {
+ "description": "id of the primary storage hosting the disk volume; returned to admin user only",
+ "name": "storageid",
+ "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": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
},
{
- "description": "Hypervisor the volume belongs to",
- "name": "hypervisor",
+ "description": "ID of the service offering for root disk",
+ "name": "serviceofferingid",
"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 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": "pod id of the volume",
- "name": "podid",
- "type": "string"
- },
- {
- "description": "cluster name where the volume is allocated",
- "name": "clustername",
- "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 path of the volume",
@@ -29642,14 +30096,105 @@
"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 the disk volume",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the bytes actually consumed on disk",
+ "name": "virtualsize",
+ "type": "long"
+ },
+ {
+ "description": "cluster name where the volume is allocated",
+ "name": "clustername",
+ "type": "string"
+ },
+ {
+ "description": "name of the virtual machine",
+ "name": "vmname",
+ "type": "string"
+ },
+ {
+ "description": "the write (bytes) of disk on the vm",
+ "name": "diskkbswrite",
+ "type": "long"
+ },
+ {
+ "description": "the ID of the ISO attached to the virtual machine",
+ "name": "isoid",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the vpn",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": " an alternate display text of the template for the virtual machine",
+ "name": "templatedisplaytext",
+ "type": "string"
+ },
+ {
+ "description": "the read (bytes) of disk on the vm",
+ "name": "diskkbsread",
+ "type": "long"
+ },
+ {
+ "description": "cluster id of the volume",
+ "name": "clusterid",
+ "type": "string"
+ },
+ {
+ "description": "ID of the snapshot from which this volume was created",
+ "name": "snapshotid",
"type": "string"
},
{
"description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.",
"name": "templateid",
"type": "string"
+ },
+ {
+ "description": "the domain associated with the disk volume",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the status of the volume",
+ "name": "status",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "name of the availability zone",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "max iops of the disk volume",
+ "name": "maxiops",
+ "type": "long"
+ },
+ {
+ "description": "name of the primary storage hosting the disk volume",
+ "name": "storage",
+ "type": "string"
+ },
+ {
+ "description": "the display text of the service offering for root disk",
+ "name": "serviceofferingdisplaytext",
+ "type": "string"
+ },
+ {
+ "description": "name of the service offering for root disk",
+ "name": "serviceofferingname",
+ "type": "string"
}
]
},
@@ -29659,14 +30204,6 @@
"name": "replaceNetworkACLList",
"params": [
{
- "description": "the ID of the private gateway",
- "length": 255,
- "name": "gatewayid",
- "related": "createPrivateGateway",
- "required": false,
- "type": "uuid"
- },
- {
"description": "the ID of the network",
"length": 255,
"name": "networkid",
@@ -29681,29 +30218,37 @@
"related": "createNetworkACLList,listNetworkACLLists",
"required": true,
"type": "uuid"
+ },
+ {
+ "description": "the ID of the private gateway",
+ "length": 255,
+ "name": "gatewayid",
+ "related": "createPrivateGateway",
+ "required": false,
+ "type": "uuid"
}
],
"response": [
+ {},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
+ "description": "true if operation is executed successfully",
+ "name": "success",
+ "type": "boolean"
},
{
"description": "the 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"
},
{}
]
@@ -29714,14 +30259,6 @@
"name": "markDefaultZoneForAccount",
"params": [
{
- "description": "Marks the account that belongs to the specified domain.",
- "length": 255,
- "name": "domainid",
- "related": "createDomain,listDomainChildren,listDomains,listDomains",
- "required": true,
- "type": "uuid"
- },
- {
"description": "The Zone ID with which the account is to be marked.",
"length": 255,
"name": "zoneid",
@@ -29736,11 +30273,80 @@
"related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts",
"required": true,
"type": "string"
+ },
+ {
+ "description": "Marks the account that belongs to the specified domain.",
+ "length": 255,
+ "name": "domainid",
+ "related": "createDomain,listDomainChildren,listDomains,listDomains",
+ "required": true,
+ "type": "uuid"
}
],
"related": "createAccount,disableAccount,enableAccount,updateAccount,listAccounts,listAccounts",
"response": [
{
+ "description": "the total number of network traffic bytes received",
+ "name": "receivedbytes",
+ "type": "long"
+ },
+ {
+ "description": "true if the account requires cleanup",
+ "name": "iscleanuprequired",
+ "type": "boolean"
+ },
+ {
+ "description": "the total number of network traffic bytes sent",
+ "name": "sentbytes",
+ "type": "long"
+ },
+ {
+ "description": "the network domain",
+ "name": "networkdomain",
+ "type": "string"
+ },
+ {
+ "description": "the total number of virtual machines deployed by this account",
+ "name": "vmtotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of networks the account can own",
+ "name": "networklimit",
+ "type": "string"
+ },
+ {
+ "description": "true if account is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {
+ "description": "details for the account",
+ "name": "accountdetails",
+ "type": "map"
+ },
+ {
+ "description": "the total number of vpcs the account can own",
+ "name": "vpclimit",
+ "type": "string"
+ },
+ {
+ "description": "the state of the account",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "the total number of public ip addresses this account can acquire",
+ "name": "iplimit",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the total secondary storage space (in GiB) the account can own",
+ "name": "secondarystoragelimit",
+ "type": "string"
+ },
+ {
"description": "the total number of networks owned by account",
"name": "networktotal",
"type": "long"
@@ -29751,48 +30357,113 @@
"type": "string"
},
{
- "description": "the default zone of the account",
- "name": "defaultzoneid",
- "type": "string"
- },
- {
- "description": "the total volume which can be used by this account",
- "name": "volumelimit",
- "type": "string"
- },
- {
- "description": "the total number of templates available to be created by this account",
- "name": "templateavailable",
- "type": "string"
- },
- {
- "description": "account type (admin, domain-admin, user)",
- "name": "accounttype",
- "type": "short"
- },
- {
- "description": "the total volume being used by this account",
- "name": "volumetotal",
+ "description": "the total memory (in MB) owned by account",
+ "name": "memorytotal",
"type": "long"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "the total 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",
+ "description": "the total memory (in MB) available to be created for this account",
+ "name": "memoryavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total volume available for this account",
+ "name": "volumeavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of projects being administrated by this account",
+ "name": "projecttotal",
"type": "long"
},
{
+ "description": "the total memory (in MB) the account can own",
+ "name": "memorylimit",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the role",
+ "name": "roleid",
+ "type": "string"
+ },
+ {
+ "description": "the total number of public ip addresses available for this account to acquire",
+ "name": "ipavailable",
+ "type": "string"
+ },
+ {
+ "description": "name of the Domain the account belongs to",
+ "name": "domain",
+ "type": "string"
+ },
+ {
"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 this account can acquire",
- "name": "iplimit",
+ "description": "the total primary storage space (in GiB) the account can own",
+ "name": "primarystoragelimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of virtual machines running for this account",
+ "name": "vmrunning",
+ "type": "integer"
+ },
+ {
+ "description": "the total number of projects available for administration by this account",
+ "name": "projectavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of virtual machines that can be deployed by this account",
+ "name": "vmlimit",
+ "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": "the total number of snapshots which can be stored by this account",
+ "name": "snapshotlimit",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the default zone of the account",
+ "name": "defaultzoneid",
+ "type": "string"
+ },
+ {
+ "description": "the total number of templates which can be created by this account",
+ "name": "templatelimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of snapshots available for this account",
+ "name": "snapshotavailable",
+ "type": "string"
+ },
+ {
+ "description": "id of the Domain the account belongs to",
+ "name": "domainid",
"type": "string"
},
{
@@ -29801,88 +30472,28 @@
"type": "string"
},
{
- "description": "true if account is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
+ "description": "account type (admin, domain-admin, user)",
+ "name": "accounttype",
+ "type": "short"
},
{
- "description": "the total number of network traffic bytes sent",
- "name": "sentbytes",
+ "description": "the total primary storage space (in GiB) owned by account",
+ "name": "primarystoragetotal",
"type": "long"
},
{
- "description": "the 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 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 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 date when this account was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the total number of virtual machines running for this account",
- "name": "vmrunning",
- "type": "integer"
+ "description": "the total number of cpu cores owned by account",
+ "name": "cputotal",
+ "type": "long"
},
{
"description": "the list of users associated with account",
"name": "user",
"response": [
{
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
- },
- {
- "description": "the domain ID of the user",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "true if user is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
- },
- {
- "description": "the type of the role",
- "name": "roletype",
- "type": "string"
- },
- {
- "description": "the timezone user was created in",
- "name": "timezone",
- "type": "string"
- },
- {
- "description": "the user ID",
- "name": "id",
- "type": "string"
+ "description": "the account type of the user",
+ "name": "accounttype",
+ "type": "short"
},
{
"description": "the ID of the role",
@@ -29890,13 +30501,13 @@
"type": "string"
},
{
- "description": "the domain name of the user",
- "name": "domain",
+ "description": "the account ID of the user",
+ "name": "accountid",
"type": "string"
},
{
- "description": "the account name of the user",
- "name": "account",
+ "description": "the api key of the user",
+ "name": "apikey",
"type": "string"
},
{
@@ -29905,23 +30516,8 @@
"type": "date"
},
{
- "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 name of the role",
- "name": "rolename",
- "type": "string"
- },
- {
- "description": "the user name",
- "name": "username",
+ "description": "the account name of the user",
+ "name": "account",
"type": "string"
},
{
@@ -29940,8 +30536,53 @@
"type": "string"
},
{
- "description": "the account ID of the user",
- "name": "accountid",
+ "description": "the user ID",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID of the user",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the domain name of the user",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "true if user is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {
+ "description": "the user name",
+ "name": "username",
+ "type": "string"
+ },
+ {
+ "description": "the timezone user was created in",
+ "name": "timezone",
+ "type": "string"
+ },
+ {
+ "description": "the user lastname",
+ "name": "lastname",
+ "type": "string"
+ },
+ {
+ "description": "the user email address",
+ "name": "email",
+ "type": "string"
+ },
+ {
+ "description": "the name of the role",
+ "name": "rolename",
+ "type": "string"
+ },
+ {
+ "description": "the source type of the user in lowercase, such as native, ldap, saml2",
+ "name": "usersource",
"type": "string"
},
{
@@ -29950,145 +30591,20 @@
"type": "boolean"
},
{
- "description": "the account type of the user",
- "name": "accounttype",
- "type": "short"
- },
- {
- "description": "the user email address",
- "name": "email",
+ "description": "the type of the role",
+ "name": "roletype",
"type": "string"
},
{
- "description": "the api key of the user",
- "name": "apikey",
- "type": "string"
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
}
],
"type": "list"
},
- {
- "description": "the total number of templates which can be created by this account",
- "name": "templatelimit",
- "type": "string"
- },
- {
- "description": "the total volume available for this account",
- "name": "volumeavailable",
- "type": "string"
- },
- {
- "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 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 number of snapshots stored by this account",
- "name": "snapshottotal",
- "type": "long"
- },
- {
- "description": "the name of the account",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the total number of 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 available for this account",
- "name": "snapshotavailable",
- "type": "string"
- },
- {
- "description": "the state of the account",
- "name": "state",
- "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 snapshots which can be stored by this account",
- "name": "snapshotlimit",
- "type": "string"
- },
- {
- "description": "details for the account",
- "name": "accountdetails",
- "type": "map"
- },
- {
- "description": "the list of acl groups that account belongs to",
- "name": "groups",
- "type": "list"
- },
- {
- "description": "the 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 number of networks the account can own",
- "name": "networklimit",
- "type": "string"
- },
- {
- "description": "the total primary storage space (in GiB) the account can own",
- "name": "primarystoragelimit",
- "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 network traffic bytes received",
- "name": "receivedbytes",
- "type": "long"
- },
- {
- "description": "the total number of virtual machines available for this account to acquire",
- "name": "vmavailable",
- "type": "string"
- },
- {
"description": "the id of the account",
"name": "id",
"type": "string"
@@ -30098,21 +30614,20 @@
"name": "secondarystorageavailable",
"type": "string"
},
- {},
{
- "description": "the total memory (in MB) owned by account",
- "name": "memorytotal",
- "type": "long"
+ "description": "the total number of virtual machines stopped for this account",
+ "name": "vmstopped",
+ "type": "integer"
},
{
- "description": "the total number of virtual machines deployed by this account",
- "name": "vmtotal",
- "type": "long"
+ "description": "the total number of virtual machines available for this account to acquire",
+ "name": "vmavailable",
+ "type": "string"
},
{
- "description": "the total number of projects being administrated by this account",
- "name": "projecttotal",
- "type": "long"
+ "description": "the total number of templates available to be created by this account",
+ "name": "templateavailable",
+ "type": "string"
},
{
"description": "the total number of vpcs available to be created for this account",
@@ -30120,23 +30635,33 @@
"type": "string"
},
{
- "description": "the total number of cpu cores owned by account",
- "name": "cputotal",
- "type": "long"
- },
- {
- "description": "true if the account requires cleanup",
- "name": "iscleanuprequired",
- "type": "boolean"
- },
- {
- "description": "the total number of projects the account can own",
- "name": "projectlimit",
+ "description": "the total primary storage space (in GiB) available to be used for this account",
+ "name": "primarystorageavailable",
"type": "string"
},
{
- "description": "the total number of vpcs the account can own",
- "name": "vpclimit",
+ "description": "the name of the account",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the date when this account was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the total number of public ip addresses allocated for this account",
+ "name": "iptotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of vpcs owned by account",
+ "name": "vpctotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of cpu cores the account can own",
+ "name": "cpulimit",
"type": "string"
},
{
@@ -30145,19 +30670,39 @@
"type": "string"
},
{
- "description": "id of the Domain the account belongs to",
- "name": "domainid",
+ "description": "the list of acl groups that account belongs to",
+ "name": "groups",
+ "type": "list"
+ },
+ {
+ "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": "name of the Domain the account belongs to",
- "name": "domain",
+ "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 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": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
}
],
"since": "4.0"
@@ -30179,8 +30724,49 @@
"related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,issueOutOfBandManagementPowerAction",
"response": [
{
- "description": "the out-of-band management interface address",
- "name": "address",
+ "description": "the operation result",
+ "name": "status",
+ "type": "boolean"
+ },
+ {
+ "description": "the out-of-band management interface password",
+ "name": "password",
+ "type": "string"
+ },
+ {
+ "description": "the out-of-band management interface port",
+ "name": "port",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the host",
+ "name": "hostid",
+ "type": "string"
+ },
+ {
+ "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 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 UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
@@ -30190,60 +30776,19 @@
},
{},
{
+ "description": "the out-of-band management interface address",
+ "name": "address",
+ "type": "string"
+ },
+ {
"description": "the out-of-band management interface powerState of the host",
"name": "powerstate",
"type": "powerstate"
},
{
- "description": "the operation result",
- "name": "status",
- "type": "boolean"
- },
- {
- "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 password",
- "name": "password",
- "type": "string"
- },
- {},
- {
- "description": "the ID of the host",
- "name": "hostid",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
"description": "the out-of-band management interface username",
"name": "username",
"type": "string"
- },
- {
- "description": "the out-of-band management interface port",
- "name": "port",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the out-of-band management action (if issued)",
- "name": "action",
- "type": "string"
}
],
"since": "4.9.0"
@@ -30262,28 +30807,6 @@
"type": "string"
},
{
- "description": "",
- "length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
- },
- {
- "description": "Determines whether all ldap users are returned or just non-cloudstack users. This option is deprecated in favour for the more option rich 'userfilter' parameter",
- "length": 255,
- "name": "listtype",
- "required": false,
- "type": "string"
- },
- {
- "description": "linked domain",
- "length": 255,
- "name": "domainid",
- "related": "createDomain,listDomainChildren,listDomains,listDomains",
- "required": false,
- "type": "uuid"
- },
- {
"description": "List by keyword",
"length": 255,
"name": "keyword",
@@ -30296,19 +30819,68 @@
"name": "page",
"required": false,
"type": "integer"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "linked domain",
+ "length": 255,
+ "name": "domainid",
+ "related": "createDomain,listDomainChildren,listDomains,listDomains",
+ "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,
+ "name": "listtype",
+ "required": false,
+ "type": "string"
}
],
"related": "",
"response": [
{
+ "description": "The user's email",
+ "name": "email",
+ "type": "string"
+ },
+ {},
+ {
+ "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 principle",
+ "name": "principal",
+ "type": "string"
+ },
+ {
+ "description": "The user's username",
+ "name": "username",
+ "type": "string"
+ },
+ {
"description": "The user's domain",
"name": "domain",
"type": "string"
},
{
- "description": "The user's firstname",
- "name": "firstname",
- "type": "string"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
{
"description": "the UUID of the latest async job acting on this object",
@@ -30319,34 +30891,7 @@
"description": "The user's 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's username",
- "name": "username",
- "type": "string"
- },
- {
- "description": "The user's principle",
- "name": "principal",
- "type": "string"
- },
- {
- "description": "The authentication source for this user as known to the system or empty if the user is not yet in cloudstack.",
- "name": "conflictingusersource",
- "type": "string"
- },
- {
- "description": "The user's email",
- "name": "email",
- "type": "string"
- },
- {},
- {}
+ }
],
"since": "4.2.0"
},
@@ -30356,6 +30901,13 @@
"name": "revokeCertificate",
"params": [
{
+ "description": "The certificate CN",
+ "length": 255,
+ "name": "cn",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "Name of the CA service provider, otherwise the default configured provider plugin will be used",
"length": 255,
"name": "provider",
@@ -30368,38 +30920,31 @@
"name": "serial",
"required": true,
"type": "string"
- },
- {
- "description": "The certificate CN",
- "length": 255,
- "name": "cn",
- "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": "any text associated with the success or failure",
"name": "displaytext",
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- }
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {}
],
"since": "4.11.0"
},
@@ -30409,10 +30954,10 @@
"name": "changeServiceForSystemVm",
"params": [
{
- "description": "the service offering ID to apply to the system vm",
+ "description": "The ID of the system vm",
"length": 255,
- "name": "serviceofferingid",
- "related": "createServiceOffering,updateServiceOffering,listServiceOfferings",
+ "name": "id",
+ "related": "migrateSystemVm,startSystemVm,changeServiceForSystemVm",
"required": true,
"type": "uuid"
},
@@ -30424,10 +30969,10 @@
"type": "map"
},
{
- "description": "The ID of the system vm",
+ "description": "the service offering ID to apply to the system vm",
"length": 255,
- "name": "id",
- "related": "migrateSystemVm,startSystemVm,changeServiceForSystemVm",
+ "name": "serviceofferingid",
+ "related": "createServiceOffering,updateServiceOffering,listServiceOfferings",
"required": true,
"type": "uuid"
}
@@ -30435,59 +30980,8 @@
"related": "migrateSystemVm,startSystemVm",
"response": [
{
- "description": "the UUID of the latest async job acting on this object",
- "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": "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": "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 private MAC address for the system VM",
- "name": "privatemacaddress",
- "type": "string"
- },
- {
- "description": "the Pod name for the system VM",
- "name": "podname",
- "type": "string"
- },
- {},
- {
- "description": "the system VM type",
- "name": "systemvmtype",
- "type": "string"
- },
- {
- "description": "the Zone name for the system VM",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "the template ID for the system VM",
- "name": "templateid",
- "type": "string"
- },
- {
- "description": "the private netmask for the system VM",
- "name": "privatenetmask",
+ "description": "the private IP address for the system VM",
+ "name": "privateip",
"type": "string"
},
{
@@ -30496,127 +30990,97 @@
"type": "string"
},
{
- "description": "the network domain for the system VM",
- "name": "networkdomain",
- "type": "string"
- },
- {
- "description": "the host ID for the system VM",
- "name": "hostid",
- "type": "string"
- },
- {
- "description": "the private IP address for the system VM",
- "name": "privateip",
- "type": "string"
- },
- {
- "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 Pod ID for the system VM",
- "name": "podid",
- "type": "string"
- },
- {
- "description": "the gateway for the system VM",
- "name": "gateway",
- "type": "string"
- },
- {
"description": "the public netmask for the system VM",
"name": "publicnetmask",
"type": "string"
},
- {},
- {
- "description": "the second DNS for the system VM",
- "name": "dns2",
- "type": "string"
- },
- {
- "description": "the hostname for the system VM",
- "name": "hostname",
- "type": "string"
- },
- {
- "description": "the Zone ID for the system VM",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the link local IP address for the system vm",
- "name": "linklocalip",
- "type": "string"
- },
- {
- "description": "the systemvm agent version",
- "name": "version",
- "type": "string"
- },
- {
- "description": "the state of the system VM",
- "name": "state",
- "type": "string"
- },
- {
- "description": "the date and time the system VM was created",
- "name": "created",
- "type": "date"
- },
{
"description": "the link local MAC address for the system vm",
"name": "linklocalmacaddress",
"type": "string"
},
{
+ "description": "the Zone name for the system VM",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
"description": "the hypervisor on which the template runs",
"name": "hypervisor",
"type": "string"
},
{
- "description": "the template name for the system VM",
- "name": "templatename",
+ "description": "the link local netmask for the system vm",
+ "name": "linklocalnetmask",
"type": "string"
},
{
- "description": "the public MAC address for the system VM",
- "name": "publicmacaddress",
+ "description": "the Zone ID for the system VM",
+ "name": "zoneid",
"type": "string"
},
{
- "description": "the ID of the system VM",
- "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"
},
{
+ "description": "the second DNS for the system VM",
+ "name": "dns2",
+ "type": "string"
+ },
+ {
"description": "guest vlan range",
"name": "guestvlan",
"type": "string"
},
{
+ "description": "the host ID for the system VM",
+ "name": "hostid",
+ "type": "string"
+ },
+ {
+ "description": "the private MAC address for the system VM",
+ "name": "privatemacaddress",
+ "type": "string"
+ },
+ {
+ "description": "the system VM type",
+ "name": "systemvmtype",
+ "type": "string"
+ },
+ {
+ "description": "public vlan range",
+ "name": "publicvlan",
+ "type": "list"
+ },
+ {},
+ {
+ "description": "the ID of the system VM",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the state of the system VM",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "the Pod ID for the system VM",
+ "name": "podid",
+ "type": "string"
+ },
+ {
"description": "the public IP address for the system VM",
"name": "publicip",
"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"
@@ -30627,8 +31091,89 @@
"type": "string"
},
{
- "description": "the link local netmask for the system vm",
- "name": "linklocalnetmask",
+ "description": "the template ID for the system VM",
+ "name": "templateid",
+ "type": "string"
+ },
+ {
+ "description": "the hostname for the system VM",
+ "name": "hostname",
+ "type": "string"
+ },
+ {
+ "description": "the date and time the system VM was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the link local IP address for the system vm",
+ "name": "linklocalip",
+ "type": "string"
+ },
+ {
+ "description": "the 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 gateway for the system VM",
+ "name": "gateway",
+ "type": "string"
+ },
+ {
+ "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.",
+ "name": "isdynamicallyscalable",
+ "type": "boolean"
+ },
+ {
+ "description": "the 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 template name for the system VM",
+ "name": "templatename",
+ "type": "string"
+ },
+ {
+ "description": "the public MAC address for the system VM",
+ "name": "publicmacaddress",
+ "type": "string"
+ },
+ {
+ "description": "the Pod name for the system VM",
+ "name": "podname",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the systemvm agent version",
+ "name": "version",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the first DNS for the system VM",
+ "name": "dns1",
+ "type": "string"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the private netmask for the system VM",
+ "name": "privatenetmask",
"type": "string"
}
]
@@ -30661,19 +31206,19 @@
"type": "uuid"
},
{
- "description": "Shares per GB",
- "length": 255,
- "name": "sharespergb",
- "required": true,
- "type": "integer"
- },
- {
"description": "Zone ID",
"length": 255,
"name": "zoneid",
"related": "createZone,updateZone,listZones,listZones",
"required": true,
"type": "uuid"
+ },
+ {
+ "description": "Shares per GB",
+ "length": 255,
+ "name": "sharespergb",
+ "required": true,
+ "type": "integer"
}
],
"related": "",
@@ -30704,21 +31249,6 @@
"name": "listIpForwardingRules",
"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",
- "length": 255,
- "name": "listall",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "list the rule belonging to this public IP address",
- "length": 255,
- "name": "ipaddressid",
- "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses",
- "required": false,
- "type": "uuid"
- },
- {
"description": "",
"length": 255,
"name": "pagesize",
@@ -30726,10 +31256,10 @@
"type": "integer"
},
{
- "description": "list only resources belonging to the domain specified",
+ "description": "list the rule belonging to this public IP address",
"length": 255,
- "name": "domainid",
- "related": "createDomain,listDomainChildren,listDomains,listDomains",
+ "name": "ipaddressid",
+ "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses",
"required": false,
"type": "uuid"
},
@@ -30742,6 +31272,27 @@
"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": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "Lists all rules applied to the specified VM.",
"length": 255,
"name": "virtualmachineid",
@@ -30750,103 +31301,82 @@
"type": "uuid"
},
{
+ "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false",
+ "length": 255,
+ "name": "listall",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "",
+ "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",
+ "required": false,
+ "type": "uuid"
+ },
+ {
"description": "Lists rule with the specified ID.",
"length": 255,
"name": "id",
"related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules",
"required": false,
"type": "uuid"
- },
- {
- "description": "list resources by account. Must be used with the domainId parameter.",
- "length": 255,
- "name": "account",
- "required": false,
- "type": "string"
- },
- {
- "description": "",
- "length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
- },
- {
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
- },
- {
- "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
- "length": 255,
- "name": "isrecursive",
- "required": false,
- "type": "boolean"
}
],
"related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule",
"response": [
{
+ "description": "the public ip address id for the port forwarding rule",
+ "name": "ipaddressid",
+ "type": "string"
+ },
+ {
"description": "the state of the rule",
"name": "state",
"type": "string"
},
{
+ "description": "the 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 public port range",
"name": "publicport",
"type": "string"
},
{
+ "description": "the ending port of port forwarding rule's private port range",
+ "name": "privateendport",
+ "type": "string"
+ },
+ {
+ "description": "the ending port of port forwarding rule's private port range",
+ "name": "publicendport",
+ "type": "string"
+ },
+ {
+ "description": "is firewall for display to the regular user",
+ "name": "fordisplay",
+ "type": "boolean"
+ },
+ {
"description": "the VM name for the port forwarding rule",
"name": "virtualmachinename",
"type": "string"
},
- {
- "description": "the public ip address id for the port forwarding rule",
- "name": "ipaddressid",
- "type": "string"
- },
{},
{
- "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).",
- "name": "cidrlist",
- "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 ID of the port forwarding rule",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the VM display name for the port forwarding rule",
- "name": "virtualmachinedisplayname",
- "type": "string"
- },
- {
- "description": "the VM 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 ending port of port forwarding rule's private port range",
- "name": "privateendport",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
@@ -30854,13 +31384,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": "id of the resource",
+ "name": "resourceid",
"type": "string"
},
{
@@ -30869,28 +31394,8 @@
"type": "string"
},
{
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "the 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"
},
{
@@ -30899,27 +31404,52 @@
"type": "string"
},
{
- "description": "the project name where tag belongs to",
- "name": "project",
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "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 ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
"type": "string"
}
],
"type": "list"
},
- {
- "description": "the ending port of port forwarding rule's private port range",
- "name": "publicendport",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
{},
{
- "description": "the public ip address for the port forwarding rule",
- "name": "ipaddress",
+ "description": "the VM display name for the port forwarding rule",
+ "name": "virtualmachinedisplayname",
+ "type": "string"
+ },
+ {
+ "description": "the vm ip address for the port forwarding rule",
+ "name": "vmguestip",
+ "type": "string"
+ },
+ {
+ "description": "the VM ID for the port forwarding rule",
+ "name": "virtualmachineid",
"type": "string"
},
{
@@ -30933,9 +31463,24 @@
"type": "string"
},
{
- "description": "is firewall for display to the regular user",
- "name": "fordisplay",
- "type": "boolean"
+ "description": "the ID of the port forwarding rule",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the starting port of port forwarding rule's private port range",
+ "name": "privateport",
+ "type": "string"
+ },
+ {
+ "description": "the public ip address for the port forwarding rule",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
}
]
},
@@ -30945,19 +31490,11 @@
"name": "createSnapshot",
"params": [
{
- "description": "The domain ID of the snapshot. If used with the account parameter, specifies a domain for the account associated with the disk volume.",
+ "description": "asynchronous backup if true",
"length": 255,
- "name": "domainid",
- "related": "createDomain,listDomainChildren,listDomains,listDomains",
+ "name": "asyncbackup",
"required": false,
- "type": "uuid"
- },
- {
- "description": "Currently applicable only for managed storage. Valid location types: 'primary', 'secondary'. Default = 'primary'.",
- "length": 255,
- "name": "locationtype",
- "required": false,
- "type": "string"
+ "type": "boolean"
},
{
"description": "the name of the snapshot",
@@ -30974,6 +31511,13 @@
"type": "map"
},
{
+ "description": "Currently applicable only for managed storage. Valid location types: 'primary', 'secondary'. Default = 'primary'.",
+ "length": 255,
+ "name": "locationtype",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "quiesce vm if true",
"length": 255,
"name": "quiescevm",
@@ -30981,21 +31525,6 @@
"type": "boolean"
},
{
- "description": "policy id of the snapshot, if this is null, then use MANUAL_POLICY.",
- "length": 255,
- "name": "policyid",
- "related": "updateSnapshotPolicy",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "asynchronous backup if true",
- "length": 255,
- "name": "asyncbackup",
- "required": false,
- "type": "boolean"
- },
- {
"description": "The ID of the disk volume",
"length": 255,
"name": "volumeid",
@@ -31009,25 +31538,32 @@
"name": "account",
"required": false,
"type": "string"
+ },
+ {
+ "description": "policy id of the snapshot, if this is null, then use MANUAL_POLICY.",
+ "length": 255,
+ "name": "policyid",
+ "related": "updateSnapshotPolicy",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "The domain ID of the snapshot. If used with the account parameter, specifies a domain for the account associated with the disk volume.",
+ "length": 255,
+ "name": "domainid",
+ "related": "createDomain,listDomainChildren,listDomains,listDomains",
+ "required": false,
+ "type": "uuid"
}
],
"related": "createSnapshotFromVMSnapshot,archiveSnapshot,revertSnapshot",
"response": [
{
- "description": "virtual size of backedup snapshot on image store",
- "name": "virtualsize",
- "type": "long"
- },
- {
"description": "display name of the os on volume",
"name": "osdisplayname",
"type": "string"
},
- {
- "description": "id of the os on volume",
- "name": "ostypeid",
- "type": "string"
- },
+ {},
{
"description": "true if the entity/resource has annotations",
"name": "hasannotations",
@@ -31038,9 +31574,20 @@
"name": "project",
"type": "string"
},
+ {},
{
- "description": "ID of the disk volume",
- "name": "volumeid",
+ "description": "indicates whether the underlying storage supports reverting the volume to this snapshot",
+ "name": "revertable",
+ "type": "boolean"
+ },
+ {
+ "description": "virtual size of backedup snapshot on image store",
+ "name": "virtualsize",
+ "type": "long"
+ },
+ {
+ "description": "the type of the snapshot",
+ "name": "snapshottype",
"type": "string"
},
{
@@ -31049,6 +31596,11 @@
"type": "string"
},
{
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
"description": "the list of resource tags associated",
"name": "tags",
"response": [
@@ -31058,13 +31610,13 @@
"type": "string"
},
{
- "description": "the account associated with the tag",
- "name": "account",
+ "description": "the project name where tag belongs to",
+ "name": "project",
"type": "string"
},
{
- "description": "tag key name",
- "name": "key",
+ "description": "the domain associated with the tag",
+ "name": "domain",
"type": "string"
},
{
@@ -31073,8 +31625,8 @@
"type": "string"
},
{
- "description": "the project name where tag belongs to",
- "name": "project",
+ "description": "resource type",
+ "name": "resourcetype",
"type": "string"
},
{
@@ -31088,33 +31640,27 @@
"type": "string"
},
{
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
"description": "customer associated with the tag",
"name": "customer",
"type": "string"
},
{
- "description": "resource type",
- "name": "resourcetype",
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
"type": "string"
}
],
"type": "set"
},
{
- "description": "id of the availability zone",
- "name": "zoneid",
- "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 account associated with the snapshot",
@@ -31127,34 +31673,28 @@
"type": "string"
},
{
- "description": "ID of the snapshot",
- "name": "id",
+ "description": "id of the availability zone",
+ "name": "zoneid",
"type": "string"
},
{
- "description": "indicates whether the underlying storage supports reverting the volume to this snapshot",
- "name": "revertable",
- "type": "boolean"
- },
- {
- "description": "the domain ID of the snapshot's account",
- "name": "domainid",
+ "description": "id of the os on volume",
+ "name": "ostypeid",
"type": "string"
},
{
- "description": " the date the snapshot was created",
- "name": "created",
- "type": "date"
+ "description": "physical size of backedup snapshot on image store",
+ "name": "physicalsize",
+ "type": "long"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
- {},
{
- "description": "the type of the snapshot",
- "name": "snapshottype",
+ "description": "name of the disk volume",
+ "name": "volumename",
"type": "string"
},
{
@@ -31163,9 +31703,19 @@
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "ID of the disk volume",
+ "name": "volumeid",
+ "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": "valid location types are primary and secondary.",
@@ -31178,18 +31728,13 @@
"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": "name of the disk volume",
- "name": "volumename",
+ "description": "ID of the snapshot",
+ "name": "id",
"type": "string"
},
{
- "description": "name of the snapshot",
- "name": "name",
+ "description": "the domain ID of the snapshot's account",
+ "name": "domainid",
"type": "string"
}
]
@@ -31209,27 +31754,27 @@
}
],
"response": [
+ {
+ "description": "any text associated with the success or failure",
+ "name": "displaytext",
+ "type": "string"
+ },
+ {},
{},
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
- {},
{
- "description": "any text associated with the success or failure",
- "name": "displaytext",
- "type": "string"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
{
"description": "true if operation is executed successfully",
"name": "success",
"type": "boolean"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
}
],
"since": "4.2.0"
@@ -31240,6 +31785,36 @@
"name": "listStoragePoolsMetrics",
"params": [
{
+ "description": "list storage pools belongig to the specific cluster",
+ "length": 255,
+ "name": "clusterid",
+ "related": "addCluster,updateCluster",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "the name of the storage pool",
+ "length": 255,
+ "name": "name",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the ID of the storage pool",
+ "length": 255,
+ "name": "id",
+ "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "the Zone ID for the storage pool",
"length": 255,
"name": "zoneid",
@@ -31248,13 +31823,28 @@
"type": "uuid"
},
{
- "description": "the IP address for the storage pool",
+ "description": "",
"length": 255,
- "name": "ipaddress",
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "the storage pool path",
+ "length": 255,
+ "name": "path",
"required": false,
"type": "string"
},
{
+ "description": "the Pod ID for the storage pool",
+ "length": 255,
+ "name": "podid",
+ "related": "updatePod,createManagementNetworkIpRange",
+ "required": false,
+ "type": "uuid"
+ },
+ {
"description": "",
"length": 255,
"name": "page",
@@ -31270,74 +31860,19 @@
"type": "string"
},
{
- "description": "List by keyword",
+ "description": "the IP address for the storage pool",
"length": 255,
- "name": "keyword",
+ "name": "ipaddress",
"required": false,
"type": "string"
- },
- {
- "description": "the name of the storage pool",
- "length": 255,
- "name": "name",
- "required": false,
- "type": "string"
- },
- {
- "description": "the Pod ID for the storage pool",
- "length": 255,
- "name": "podid",
- "related": "updatePod,createManagementNetworkIpRange",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "list storage pools belongig to the specific cluster",
- "length": 255,
- "name": "clusterid",
- "related": "addCluster,updateCluster",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "the storage pool path",
- "length": 255,
- "name": "path",
- "required": false,
- "type": "string"
- },
- {
- "description": "",
- "length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
- },
- {
- "description": "the ID of the storage pool",
- "length": 255,
- "name": "id",
- "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities",
- "required": false,
- "type": "uuid"
}
],
"related": "",
"response": [
{
- "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",
- "type": "string"
- },
- {
- "description": "the Zone name of the storage pool",
- "name": "zonename",
- "type": "string"
+ "description": "true if this pool is suitable to migrate a volume, false otherwise",
+ "name": "suitableformigration",
+ "type": "boolean"
},
{
"description": "the ID of the cluster for the storage pool",
@@ -31345,47 +31880,87 @@
"type": "string"
},
{
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
+ "description": "the scope of the storage pool",
+ "name": "scope",
+ "type": "string"
+ },
+ {
+ "description": "IOPS CloudStack can provision from this storage pool",
+ "name": "capacityiops",
+ "type": "long"
+ },
+ {
+ "description": "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 overprovisionfactor for the storage pool",
+ "name": "overprovisionfactor",
+ "type": "string"
+ },
+ {
+ "description": "disk size used in GiB",
+ "name": "disksizeusedgb",
+ "type": "string"
+ },
+ {
+ "description": "the Zone ID of the storage pool",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the storage pool capabilities",
+ "name": "storagecapabilities",
+ "type": "map"
+ },
+ {
+ "description": "the hypervisor type of the storage pool",
+ "name": "hypervisor",
+ "type": "string"
+ },
+ {
+ "description": "the Zone name of the storage pool",
+ "name": "zonename",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the host's currently used disk size",
+ "name": "disksizeused",
+ "type": "long"
+ },
+ {
+ "description": "storage allocated notification threshold exceeded",
+ "name": "storageallocatedthreshold",
"type": "boolean"
},
{
- "description": "true if this pool is suitable to migrate a volume, false otherwise",
- "name": "suitableformigration",
- "type": "boolean"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the state of the storage pool",
+ "name": "state",
+ "type": "storagepoolstatus"
},
{
"description": "Storage provider for this pool",
"name": "provider",
"type": "string"
},
- {},
- {
- "description": "storage allocated disable threshold exceeded",
- "name": "storageallocateddisablethreshold",
- "type": "boolean"
- },
- {
- "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 Pod ID of the storage pool",
- "name": "podid",
- "type": "string"
- },
- {
- "description": "storage allocated notification threshold exceeded",
- "name": "storageallocatedthreshold",
- "type": "boolean"
- },
- {
"description": "the name of the storage pool",
"name": "name",
"type": "string"
@@ -31396,114 +31971,84 @@
"type": "boolean"
},
{
- "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 storage pool type",
- "name": "type",
- "type": "string"
- },
- {
- "description": "the hypervisor type of the storage pool",
- "name": "hypervisor",
- "type": "string"
- },
- {
- "description": "the overprovisionfactor for the storage pool",
- "name": "overprovisionfactor",
- "type": "string"
- },
- {
- "description": "the state of the storage pool",
- "name": "state",
- "type": "storagepoolstatus"
- },
- {
- "description": "the IP address of the storage pool",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "description": "the host's currently allocated disk size",
- "name": "disksizeallocated",
- "type": "long"
- },
- {
- "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": "the scope of the storage pool",
- "name": "scope",
- "type": "string"
- },
- {
- "description": "storage usage notification threshold exceeded",
- "name": "storageusagethreshold",
- "type": "boolean"
- },
- {
- "description": "the host's currently used disk size",
- "name": "disksizeused",
- "type": "long"
- },
- {
- "description": "the date and time the storage pool was created",
- "name": "created",
- "type": "date"
- },
- {
"description": "disk size unallocated in GiB",
"name": "disksizeunallocatedgb",
"type": "string"
},
{
- "description": "the Zone ID of the storage pool",
- "name": "zoneid",
- "type": "string"
- },
- {},
- {
- "description": "the total disk size of the storage pool",
- "name": "disksizetotal",
- "type": "long"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "IOPS CloudStack can provision from this storage pool",
- "name": "capacityiops",
- "type": "long"
- },
- {
- "description": "disk size allocated in GiB",
- "name": "disksizeallocatedgb",
- "type": "string"
- },
- {
"description": "disk size in GiB",
"name": "disksizetotalgb",
"type": "string"
},
{
- "description": "disk size used in GiB",
- "name": "disksizeusedgb",
+ "description": "the total disk size of the storage pool",
+ "name": "disksizetotal",
+ "type": "long"
+ },
+ {
+ "description": "the storage pool path",
+ "name": "path",
+ "type": "string"
+ },
+ {
+ "description": "the tags for the storage pool",
+ "name": "tags",
+ "type": "string"
+ },
+ {
+ "description": "storage usage notification threshold exceeded",
+ "name": "storageusagethreshold",
+ "type": "boolean"
+ },
+ {
+ "description": "the IP address of the storage pool",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "storage allocated disable threshold exceeded",
+ "name": "storageallocateddisablethreshold",
+ "type": "boolean"
+ },
+ {
+ "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 Pod ID of the storage pool",
+ "name": "podid",
+ "type": "string"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "disk size allocated in GiB",
+ "name": "disksizeallocatedgb",
+ "type": "string"
+ },
+ {
+ "description": "the storage pool type",
+ "name": "type",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the storage pool",
+ "name": "id",
"type": "string"
}
],
@@ -31526,27 +32071,27 @@
"related": "",
"response": [
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {},
- {
"description": "details of the unmanage VM operation",
"name": "details",
"type": "string"
},
- {},
{
- "description": "result of the unmanage VM operation",
- "name": "success",
- "type": "boolean"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
- }
+ },
+ {
+ "description": "result of the unmanage VM operation",
+ "name": "success",
+ "type": "boolean"
+ },
+ {},
+ {}
],
"since": "4.15.0"
},
@@ -31556,185 +32101,28 @@
"name": "rebootRouter",
"params": [
{
- "description": "the ID of the router",
- "length": 255,
- "name": "id",
- "related": "destroyRouter,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"
+ },
+ {
+ "description": "the ID of the router",
+ "length": 255,
+ "name": "id",
+ "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs",
+ "required": true,
+ "type": "uuid"
}
],
"related": "destroyRouter,listRouters,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs",
"response": [
{
- "description": "the link local netmask for the router",
- "name": "linklocalnetmask",
- "type": "string"
- },
- {
- "description": "the guest MAC address for the router",
- "name": "guestmacaddress",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the domain associated with the router",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the guest netmask for the router",
- "name": "guestnetmask",
- "type": "string"
- },
- {
- "description": "the list of nics associated with the router",
- "name": "nic",
- "response": [
- {
- "description": "the ip address of the nic",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "description": "the isolation uri of the nic",
- "name": "isolationuri",
- "type": "string"
- },
- {
- "description": "true if nic is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
- },
- {
- "description": "the gateway of IPv6 network",
- "name": "ip6gateway",
- "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 IPv6 address of network",
- "name": "ip6address",
- "type": "string"
- },
- {
- "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 cidr of IPv6 network",
- "name": "ip6cidr",
- "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 corresponding network",
- "name": "networkid",
- "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": "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": "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 netmask of the nic",
- "name": "netmask",
- "type": "string"
- },
- {
- "description": "the gateway of the nic",
- "name": "gateway",
- "type": "string"
- },
- {
- "description": "the type of the nic",
- "name": "type",
- "type": "string"
- },
- {
- "description": "the traffic type of the nic",
- "name": "traffictype",
- "type": "string"
- },
- {
- "description": "the ID of the nic",
- "name": "id",
- "type": "string"
- },
- {
- "description": "Id of the NSX Logical Switch (if NSX based), null otherwise",
- "name": "nsxlogicalswitch",
- "type": "string"
- }
- ],
- "type": "set"
+ "description": "the state of the router",
+ "name": "state",
+ "type": "state"
},
{
"description": "true if the router template requires upgrader",
@@ -31742,13 +32130,8 @@
"type": "boolean"
},
{
- "description": "the guest IP address for the router",
- "name": "guestipaddress",
- "type": "string"
- },
- {
- "description": "the name of the router",
- "name": "name",
+ "description": "the guest netmask for the router",
+ "name": "guestnetmask",
"type": "string"
},
{
@@ -31757,58 +32140,38 @@
"type": "string"
},
{
- "description": "the Pod ID for the router",
- "name": "podid",
+ "description": "the name of the router",
+ "name": "name",
"type": "string"
},
{
- "description": "the network domain for the router",
- "name": "networkdomain",
+ "description": "if this router is an redundant virtual router",
+ "name": "isredundantrouter",
+ "type": "boolean"
+ },
+ {
+ "description": "the name of the corresponding guest network",
+ "name": "guestnetworkname",
"type": "string"
},
{
- "description": "the host ID for the router",
- "name": "hostid",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
- "description": "the ID of the corresponding guest network",
- "name": "guestnetworkid",
+ "description": "the Zone name for the router",
+ "name": "zonename",
"type": "string"
},
{
- "description": "the public netmask for the router",
- "name": "publicnetmask",
+ "description": "the template ID for the router",
+ "name": "templateid",
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the domain ID associated with the router",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the ID of the corresponding public network",
- "name": "publicnetworkid",
- "type": "string"
- },
- {
- "description": "the account associated with the router",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the hypervisor on which the template runs",
- "name": "hypervisor",
- "type": "string"
- },
- {
- "description": "the project id of the ipaddress",
- "name": "projectid",
+ "description": "the guest IP address for the router",
+ "name": "guestipaddress",
"type": "string"
},
{
@@ -31817,24 +32180,38 @@
"type": "string"
},
{
- "description": "the link local IP address for the router",
- "name": "linklocalip",
- "type": "string"
- },
- {},
- {
"description": "the second IPv6 DNS for the router",
"name": "ip6dns2",
"type": "string"
},
{
- "description": "true if any health checks had failed",
- "name": "healthchecksfailed",
- "type": "boolean"
+ "description": "the gateway for the router",
+ "name": "gateway",
+ "type": "string"
},
{
- "description": "role of the domain router",
- "name": "role",
+ "description": "the guest MAC address for the router",
+ "name": "guestmacaddress",
+ "type": "string"
+ },
+ {
+ "description": "the first DNS for the router",
+ "name": "dns1",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the corresponding guest network",
+ "name": "guestnetworkid",
+ "type": "string"
+ },
+ {
+ "description": "the Pod name for the router",
+ "name": "podname",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the corresponding public network",
+ "name": "publicnetworkid",
"type": "string"
},
{
@@ -31843,15 +32220,46 @@
"type": "string"
},
{
+ "description": "the first IPv6 DNS for the router",
+ "name": "ip6dns1",
+ "type": "string"
+ },
+ {
+ "description": "the version of scripts",
+ "name": "scriptsversion",
+ "type": "string"
+ },
+ {
+ "description": "the link local netmask for the router",
+ "name": "linklocalnetmask",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the router",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "true if any health checks had failed",
+ "name": "healthchecksfailed",
+ "type": "boolean"
+ },
+ {
+ "description": "the id of the router",
+ "name": "id",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the date and time the router was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
"description": "Last executed health check result for the router",
"name": "healthcheckresults",
"response": [
{
- "description": "the 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"
@@ -31867,6 +32275,11 @@
"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"
@@ -31874,10 +32287,19 @@
],
"type": "list"
},
- {},
{
- "description": "the version of template",
- "name": "version",
+ "description": "the hostname for the router",
+ "name": "hostname",
+ "type": "string"
+ },
+ {
+ "description": "the host ID for the router",
+ "name": "hostid",
+ "type": "string"
+ },
+ {
+ "description": "role of the domain router",
+ "name": "role",
"type": "string"
},
{
@@ -31886,83 +32308,18 @@
"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 domain associated with the router",
+ "name": "domain",
"type": "string"
},
{
- "description": "if this router is an redundant virtual router",
- "name": "isredundantrouter",
- "type": "boolean"
- },
- {
- "description": "the first IPv6 DNS for the router",
- "name": "ip6dns1",
+ "description": "the network domain for the router",
+ "name": "networkdomain",
"type": "string"
},
{
- "description": "the id of the router",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the Zone name for the router",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "the ID of the corresponding link local network",
- "name": "linklocalnetworkid",
- "type": "string"
- },
- {
- "description": "the template name for the router",
- "name": "templatename",
- "type": "string"
- },
- {
- "description": "the state of the router",
- "name": "state",
- "type": "state"
- },
- {
- "description": "the gateway for the router",
- "name": "gateway",
- "type": "string"
- },
- {
- "description": "the Pod name for the router",
- "name": "podname",
- "type": "string"
- },
- {
- "description": "the version of scripts",
- "name": "scriptsversion",
- "type": "string"
- },
- {
- "description": "the state of redundant virtual router",
- "name": "redundantstate",
- "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 hostname for the router",
- "name": "hostname",
+ "description": "the link local IP address for the router",
+ "name": "linklocalip",
"type": "string"
},
{
@@ -31971,14 +32328,14 @@
"type": "string"
},
{
- "description": "the first DNS for the router",
- "name": "dns1",
+ "description": "the ID of the service offering of the virtual machine",
+ "name": "serviceofferingid",
"type": "string"
},
{
- "description": "the template ID for the router",
- "name": "templateid",
- "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",
@@ -31986,8 +32343,24 @@
"type": "string"
},
{
- "description": "VPC the router belongs to",
- "name": "vpcid",
+ "description": "the state of redundant virtual router",
+ "name": "redundantstate",
+ "type": "string"
+ },
+ {
+ "description": "the version of template",
+ "name": "version",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID associated with the router",
+ "name": "domainid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the public MAC address for the router",
+ "name": "publicmacaddress",
"type": "string"
},
{
@@ -31996,8 +32369,180 @@
"type": "string"
},
{
- "description": "the public MAC address for the router",
- "name": "publicmacaddress",
+ "description": "the list of nics associated with the router",
+ "name": "nic",
+ "response": [
+ {
+ "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 vm to which the nic belongs",
+ "name": "virtualmachineid",
+ "type": "string"
+ },
+ {
+ "description": "the isolation uri of the nic",
+ "name": "isolationuri",
+ "type": "string"
+ },
+ {
+ "description": "the name of the corresponding network",
+ "name": "networkname",
+ "type": "string"
+ },
+ {
+ "description": "the IPv6 address of network",
+ "name": "ip6address",
+ "type": "string"
+ },
+ {
+ "description": "the ip address of the nic",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "the isolated private VLAN if available",
+ "name": "isolatedpvlan",
+ "type": "integer"
+ },
+ {
+ "description": "the traffic type of the nic",
+ "name": "traffictype",
+ "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": "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 type of the nic",
+ "name": "type",
+ "type": "string"
+ },
+ {
+ "description": "Type of adapter if available",
+ "name": "adaptertype",
+ "type": "string"
+ },
+ {
+ "description": "the cidr of IPv6 network",
+ "name": "ip6cidr",
+ "type": "string"
+ },
+ {
+ "description": "the broadcast uri of the nic",
+ "name": "broadcasturi",
+ "type": "string"
+ },
+ {
+ "description": "the Secondary ipv4 addr of nic",
+ "name": "secondaryip",
+ "type": "list"
+ },
+ {
+ "description": "true if nic is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {
+ "description": "the netmask of the nic",
+ "name": "netmask",
+ "type": "string"
+ },
+ {
+ "description": "the extra dhcp options on the nic",
+ "name": "extradhcpoption",
+ "type": "list"
+ },
+ {
+ "description": "device id for the network when plugged into the virtual machine",
+ "name": "deviceid",
+ "type": "string"
+ },
+ {
+ "description": "true if nic is default, false otherwise",
+ "name": "macaddress",
+ "type": "string"
+ },
+ {
+ "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise",
+ "name": "nsxlogicalswitchport",
+ "type": "string"
+ },
+ {
+ "description": "the isolated private VLAN type if available",
+ "name": "isolatedpvlantype",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the hypervisor on which the template runs",
+ "name": "hypervisor",
+ "type": "string"
+ },
+ {
+ "description": "the Pod ID for the router",
+ "name": "podid",
+ "type": "string"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the public netmask for the router",
+ "name": "publicnetmask",
+ "type": "string"
+ },
+ {
+ "description": "the project id of the ipaddress",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the template name for the router",
+ "name": "templatename",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the corresponding link local network",
+ "name": "linklocalnetworkid",
+ "type": "string"
+ },
+ {
+ "description": "VPC the router belongs to",
+ "name": "vpcid",
"type": "string"
}
]
@@ -32008,14 +32553,6 @@
"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": "List by keyword",
"length": 255,
"name": "keyword",
@@ -32023,11 +32560,11 @@
"type": "string"
},
{
- "description": "list nic of the specific vm's network",
+ "description": "the ID of the vm",
"length": 255,
- "name": "networkid",
- "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks",
- "required": false,
+ "name": "virtualmachineid",
+ "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance",
+ "required": true,
"type": "uuid"
},
{
@@ -32039,6 +32576,14 @@
"type": "uuid"
},
{
+ "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter",
+ "length": 255,
+ "name": "fordisplay",
+ "required": false,
+ "since": "4.4",
+ "type": "boolean"
+ },
+ {
"description": "",
"length": 255,
"name": "page",
@@ -32046,94 +32591,35 @@
"type": "integer"
},
{
- "description": "the ID of the vm",
- "length": 255,
- "name": "virtualmachineid",
- "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance",
- "required": true,
- "type": "uuid"
- },
- {
"description": "",
"length": 255,
"name": "pagesize",
"required": false,
"type": "integer"
+ },
+ {
+ "description": "list nic of the specific vm's network",
+ "length": 255,
+ "name": "networkid",
+ "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks",
+ "required": false,
+ "type": "uuid"
}
],
"related": "",
"response": [
+ {},
{
"description": "the gateway of the nic",
"name": "gateway",
"type": "string"
},
{
- "description": "Id of the vm to which the nic belongs",
- "name": "virtualmachineid",
- "type": "string"
- },
- {
- "description": "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 isolated private VLAN type if available",
"name": "isolatedpvlantype",
"type": "string"
},
{
- "description": "the name of the corresponding network",
- "name": "networkname",
- "type": "string"
- },
- {
- "description": "the netmask of the nic",
- "name": "netmask",
- "type": "string"
- },
- {
- "description": "the IPv6 address of network",
- "name": "ip6address",
- "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": "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": "Type of adapter if available",
- "name": "adaptertype",
- "type": "string"
- },
- {
- "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise",
- "name": "nsxlogicalswitchport",
- "type": "string"
- },
- {
"description": "the Secondary ipv4 addr of nic",
"name": "secondaryip",
"type": "list"
@@ -32144,55 +32630,33 @@
"type": "string"
},
{
- "description": "the ID of the nic",
- "name": "id",
+ "description": "device id for the network when plugged into the virtual machine",
+ "name": "deviceid",
"type": "string"
},
- {},
- {
- "description": "true if nic is default, false otherwise",
- "name": "macaddress",
- "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 current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {},
{
"description": "the isolation uri of the nic",
"name": "isolationuri",
"type": "string"
},
{
- "description": "ID of the VLAN/VNI if available",
- "name": "vlanid",
- "type": "integer"
- },
- {
- "description": "the traffic type of the nic",
- "name": "traffictype",
+ "description": "the cidr of IPv6 network",
+ "name": "ip6cidr",
"type": "string"
},
{
- "description": "the ID of the corresponding network",
- "name": "networkid",
+ "description": "Type of adapter if available",
+ "name": "adaptertype",
"type": "string"
},
{
- "description": "device id for the network when plugged into the virtual machine",
- "name": "deviceid",
+ "description": "IP addresses associated with NIC found for unmanaged VM",
+ "name": "ipaddresses",
+ "type": "list"
+ },
+ {
+ "description": "the netmask of the nic",
+ "name": "netmask",
"type": "string"
},
{
@@ -32201,9 +32665,90 @@
"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 ip address of the nic",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise",
+ "name": "nsxlogicalswitchport",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "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": "isdefault",
"type": "boolean"
+ },
+ {},
+ {
+ "description": "the name of the corresponding network",
+ "name": "networkname",
+ "type": "string"
+ },
+ {
+ "description": "the extra dhcp options on the nic",
+ "name": "extradhcpoption",
+ "type": "list"
+ },
+ {
+ "description": "the 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 gateway of IPv6 network",
+ "name": "ip6gateway",
+ "type": "string"
+ },
+ {
+ "description": "true if nic is default, false otherwise",
+ "name": "macaddress",
+ "type": "string"
+ },
+ {
+ "description": "the type of the nic",
+ "name": "type",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the corresponding network",
+ "name": "networkid",
+ "type": "string"
+ },
+ {
+ "description": "ID of the VLAN/VNI if available",
+ "name": "vlanid",
+ "type": "integer"
}
]
},
@@ -32213,12 +32758,11 @@
"name": "createSSHKeyPair",
"params": [
{
- "description": "an optional domainId for the ssh key. If the account parameter is used, domainId must also be used.",
+ "description": "an optional account for the ssh key. Must be used with domainId.",
"length": 255,
- "name": "domainid",
- "related": "createDomain,listDomainChildren,listDomains,listDomains",
+ "name": "account",
"required": false,
- "type": "uuid"
+ "type": "string"
},
{
"description": "Name of the keypair",
@@ -32228,32 +32772,32 @@
"type": "string"
},
{
- "description": "an optional account for the ssh key. Must be used with domainId.",
- "length": 255,
- "name": "account",
- "required": false,
- "type": "string"
- },
- {
"description": "an optional project for the ssh key",
"length": 255,
"name": "projectid",
"related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject",
"required": false,
"type": "uuid"
+ },
+ {
+ "description": "an optional domainId for the ssh key. If the account parameter is used, domainId must also be used.",
+ "length": 255,
+ "name": "domainid",
+ "related": "createDomain,listDomainChildren,listDomains,listDomains",
+ "required": false,
+ "type": "uuid"
}
],
"related": "",
"response": [
{
- "description": "the domain name of the keypair owner",
- "name": "domain",
+ "description": "ID of the ssh keypair",
+ "name": "id",
"type": "string"
},
- {},
{
- "description": "the domain id of the keypair owner",
- "name": "domainid",
+ "description": "the owner of the keypair",
+ "name": "account",
"type": "string"
},
{
@@ -32267,13 +32811,19 @@
"type": "boolean"
},
{
- "description": "ID of the ssh keypair",
- "name": "id",
+ "description": "Name of the keypair",
+ "name": "name",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "Private key",
+ "name": "privatekey",
"type": "string"
},
{
- "description": "Name of the keypair",
- "name": "name",
+ "description": "the domain id of the keypair owner",
+ "name": "domainid",
"type": "string"
},
{
@@ -32282,20 +32832,15 @@
"type": "string"
},
{
- "description": "Private key",
- "name": "privatekey",
- "type": "string"
- },
- {
- "description": "the owner of the keypair",
- "name": "account",
- "type": "string"
- },
- {
"description": "Fingerprint of the public key",
"name": "fingerprint",
"type": "string"
},
+ {
+ "description": "the domain name of the keypair owner",
+ "name": "domain",
+ "type": "string"
+ },
{}
]
},
@@ -32305,6 +32850,14 @@
"name": "createSnapshotFromVMSnapshot",
"params": [
{
+ "description": "The ID of the VM snapshot",
+ "length": 255,
+ "name": "vmsnapshotid",
+ "related": "listVMSnapshot,createVMSnapshot",
+ "required": true,
+ "type": "uuid"
+ },
+ {
"description": "the name of the snapshot",
"length": 255,
"name": "name",
@@ -32318,41 +32871,34 @@
"related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume",
"required": true,
"type": "uuid"
- },
- {
- "description": "The ID of the VM snapshot",
- "length": 255,
- "name": "vmsnapshotid",
- "related": "listVMSnapshot,createVMSnapshot",
- "required": true,
- "type": "uuid"
}
],
"related": "archiveSnapshot,revertSnapshot",
"response": [
+ {},
{
- "description": "the domain name of the snapshot's account",
- "name": "domain",
+ "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": "virtual size of backedup snapshot on image store",
+ "name": "virtualsize",
+ "type": "long"
+ },
+ {
+ "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 current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "ID of the snapshot",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the domain ID of the snapshot's account",
+ "name": "domainid",
"type": "string"
},
{
@@ -32361,82 +32907,31 @@
"type": "boolean"
},
{
- "description": "the domain ID of the snapshot's account",
- "name": "domainid",
+ "description": "valid types are hourly, daily, weekly, monthy, template, and none.",
+ "name": "intervaltype",
"type": "string"
},
- {
- "description": "display name of the os on volume",
- "name": "osdisplayname",
- "type": "string"
- },
+ {},
{
"description": "the account associated with the snapshot",
"name": "account",
"type": "string"
},
{
- "description": "id of the os on volume",
- "name": "ostypeid",
- "type": "string"
- },
- {
- "description": "name of the disk volume",
- "name": "volumename",
- "type": "string"
- },
- {
- "description": "the project name of the snapshot",
- "name": "project",
- "type": "string"
- },
- {
- "description": "physical size of backedup snapshot on image store",
- "name": "physicalsize",
- "type": "long"
- },
- {
- "description": "id of the availability zone",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the type of the snapshot",
- "name": "snapshottype",
- "type": "string"
- },
- {
- "description": "type of the disk volume",
- "name": "volumetype",
- "type": "string"
- },
- {
- "description": "the project id of the snapshot",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "name of the snapshot",
- "name": "name",
- "type": "string"
- },
- {
- "description": "indicates whether the underlying storage supports reverting the volume to this snapshot",
- "name": "revertable",
- "type": "boolean"
- },
- {},
- {
- "description": "ID of the disk volume",
- "name": "volumeid",
- "type": "string"
- },
- {},
- {
"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": "tag key name",
"name": "key",
"type": "string"
@@ -32447,31 +32942,21 @@
"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 domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
"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"
@@ -32482,31 +32967,91 @@
"type": "string"
},
{
- "description": "the project id the tag belongs to",
- "name": "projectid",
+ "description": "the project name where tag belongs to",
+ "name": "project",
"type": "string"
}
],
"type": "set"
},
{
+ "description": "ID of the snapshot",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "type of the disk volume",
+ "name": "volumetype",
+ "type": "string"
+ },
+ {
+ "description": "the project id of the snapshot",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the domain name of the snapshot's account",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "ID of the disk volume",
+ "name": "volumeid",
+ "type": "string"
+ },
+ {
+ "description": "display name of the os on volume",
+ "name": "osdisplayname",
+ "type": "string"
+ },
+ {
+ "description": "id of the os on volume",
+ "name": "ostypeid",
+ "type": "string"
+ },
+ {
"description": " the date the snapshot was created",
"name": "created",
"type": "date"
},
{
- "description": "valid types are hourly, daily, weekly, monthy, template, and none.",
- "name": "intervaltype",
+ "description": "valid location types are primary and secondary.",
+ "name": "locationtype",
"type": "string"
},
{
- "description": "virtual size of backedup snapshot on image store",
- "name": "virtualsize",
- "type": "long"
+ "description": "id of the availability zone",
+ "name": "zoneid",
+ "type": "string"
},
{
- "description": "valid location types are primary and secondary.",
- "name": "locationtype",
+ "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage",
+ "name": "state",
+ "type": "state"
+ },
+ {
+ "description": "the project name of the snapshot",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "name of the disk volume",
+ "name": "volumename",
+ "type": "string"
+ },
+ {
+ "description": "the type of the snapshot",
+ "name": "snapshottype",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
}
],
@@ -32518,6 +33063,13 @@
"name": "authorizeSecurityGroupEgress",
"params": [
{
+ "description": "The name of the security group. Mutually exclusive with securityGroupId parameter",
+ "length": 255,
+ "name": "securitygroupname",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "TCP is default. UDP is the other supported protocol",
"length": 255,
"name": "protocol",
@@ -32525,6 +33077,13 @@
"type": "string"
},
{
+ "description": "type of the icmp message being sent",
+ "length": 255,
+ "name": "icmptype",
+ "required": false,
+ "type": "integer"
+ },
+ {
"description": "start port for this egress rule",
"length": 255,
"name": "startport",
@@ -32532,19 +33091,18 @@
"type": "integer"
},
{
- "description": "error code for this icmp message",
+ "description": "the cidr list associated. Multiple entries must be separated by a single comma character (,).",
"length": 255,
- "name": "icmpcode",
+ "name": "cidrlist",
"required": false,
- "type": "integer"
+ "type": "list"
},
{
- "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.",
+ "description": "end port for this egress rule",
"length": 255,
- "name": "domainid",
- "related": "createDomain,listDomainChildren,listDomains,listDomains",
+ "name": "endport",
"required": false,
- "type": "uuid"
+ "type": "integer"
},
{
"description": "an optional account for the security group. Must be used with domainId.",
@@ -32562,11 +33120,11 @@
"type": "uuid"
},
{
- "description": "The name of the security group. Mutually exclusive with securityGroupId parameter",
+ "description": "error code for this icmp message",
"length": 255,
- "name": "securitygroupname",
+ "name": "icmpcode",
"required": false,
- "type": "string"
+ "type": "integer"
},
{
"description": "user to security group mapping",
@@ -32576,33 +33134,20 @@
"type": "map"
},
{
- "description": "end port for this egress rule",
- "length": 255,
- "name": "endport",
- "required": false,
- "type": "integer"
- },
- {
- "description": "type of the icmp message being sent",
- "length": 255,
- "name": "icmptype",
- "required": false,
- "type": "integer"
- },
- {
- "description": "the cidr list associated. Multiple entries must be separated by a single comma character (,).",
- "length": 255,
- "name": "cidrlist",
- "required": false,
- "type": "list"
- },
- {
"description": "an optional project of the security group",
"length": 255,
"name": "projectid",
"related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject",
"required": false,
"type": "uuid"
+ },
+ {
+ "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",
+ "required": false,
+ "type": "uuid"
}
],
"related": "authorizeSecurityGroupIngress",
@@ -32613,74 +33158,64 @@
"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 UUID of the latest async job acting on this object",
- "name": "jobid",
+ "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 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 CIDR notation for the base IP address of the security group rule",
+ "name": "cidr",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the ending IP of the security group rule ",
+ "name": "endport",
+ "type": "integer"
+ },
{
"description": "the list of resource tags associated with the rule",
"name": "tags",
"response": [
{
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
"description": "id of the resource",
"name": "resourceid",
"type": "string"
},
{
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
+ "description": "tag value",
+ "name": "value",
"type": "string"
},
{
@@ -32689,37 +33224,47 @@
"type": "string"
},
{
- "description": "tag value",
- "name": "value",
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "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"
}
],
"type": "set"
},
{
- "description": "the id of the security group rule",
- "name": "ruleid",
- "type": "string"
- },
- {
- "description": "the protocol of the security group rule",
- "name": "protocol",
- "type": "string"
- },
- {
- "description": "the 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"
}
],
"since": "3.0.0"
@@ -32730,36 +33275,6 @@
"name": "listStoragePools",
"params": [
{
- "description": "the storage pool path",
- "length": 255,
- "name": "path",
- "required": false,
- "type": "string"
- },
- {
- "description": "the ID of the storage pool",
- "length": 255,
- "name": "id",
- "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "the name of the storage pool",
- "length": 255,
- "name": "name",
- "required": false,
- "type": "string"
- },
- {
- "description": "the Zone ID for the storage pool",
- "length": 255,
- "name": "zoneid",
- "related": "createZone,updateZone,listZones,listZones",
- "required": false,
- "type": "uuid"
- },
- {
"description": "List by keyword",
"length": 255,
"name": "keyword",
@@ -32767,14 +33282,6 @@
"type": "string"
},
{
- "description": "the Pod ID for the storage pool",
- "length": 255,
- "name": "podid",
- "related": "updatePod,createManagementNetworkIpRange",
- "required": false,
- "type": "uuid"
- },
- {
"description": "list storage pools belongig to the specific cluster",
"length": 255,
"name": "clusterid",
@@ -32783,6 +33290,21 @@
"type": "uuid"
},
{
+ "description": "the Pod ID for the storage pool",
+ "length": 255,
+ "name": "podid",
+ "related": "updatePod,createManagementNetworkIpRange",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "the storage pool path",
+ "length": 255,
+ "name": "path",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "",
"length": 255,
"name": "page",
@@ -32790,6 +33312,14 @@
"type": "integer"
},
{
+ "description": "the Zone ID for the storage pool",
+ "length": 255,
+ "name": "zoneid",
+ "related": "createZone,updateZone,listZones,listZones",
+ "required": false,
+ "type": "uuid"
+ },
+ {
"description": "the IP address for the storage pool",
"length": 255,
"name": "ipaddress",
@@ -32799,10 +33329,10 @@
{
"description": "the ID of the storage pool",
"length": 255,
- "name": "scope",
+ "name": "id",
"related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities",
"required": false,
- "type": "string"
+ "type": "uuid"
},
{
"description": "",
@@ -32810,18 +33340,28 @@
"name": "pagesize",
"required": false,
"type": "integer"
+ },
+ {
+ "description": "the ID of the storage pool",
+ "length": 255,
+ "name": "scope",
+ "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the name of the storage pool",
+ "length": 255,
+ "name": "name",
+ "required": false,
+ "type": "string"
}
],
"related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities",
"response": [
{
- "description": "Storage provider for this pool",
- "name": "provider",
- "type": "string"
- },
- {
- "description": "the overprovisionfactor for the storage pool",
- "name": "overprovisionfactor",
+ "description": "the ID of the storage pool",
+ "name": "id",
"type": "string"
},
{
@@ -32830,48 +33370,18 @@
"type": "storagepoolstatus"
},
{
- "description": "the name of the cluster for the storage pool",
- "name": "clustername",
- "type": "string"
- },
- {
- "description": "the hypervisor type of the storage pool",
- "name": "hypervisor",
- "type": "string"
- },
- {
- "description": "the storage pool path",
- "name": "path",
- "type": "string"
- },
- {
"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",
- "type": "long"
- },
- {
- "description": "the name of the storage pool",
- "name": "name",
+ "description": "the Pod name of the storage pool",
+ "name": "podname",
"type": "string"
},
{
- "description": "the storage pool type",
- "name": "type",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the ID of the storage pool",
- "name": "id",
+ "description": "the Zone name of the storage pool",
+ "name": "zonename",
"type": "string"
},
{
@@ -32880,9 +33390,14 @@
"type": "long"
},
{
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
+ "description": "the IP address of the storage pool",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "the name of the storage pool",
+ "name": "name",
+ "type": "string"
},
{
"description": "the scope of the storage pool",
@@ -32890,8 +33405,18 @@
"type": "string"
},
{
- "description": "the IP address of the storage pool",
- "name": "ipaddress",
+ "description": "the ID of the cluster for the storage pool",
+ "name": "clusterid",
+ "type": "string"
+ },
+ {
+ "description": "the host's currently used disk size",
+ "name": "disksizeused",
+ "type": "long"
+ },
+ {
+ "description": "the Pod ID of the storage pool",
+ "name": "podid",
"type": "string"
},
{
@@ -32900,45 +33425,59 @@
"type": "string"
},
{
+ "description": "the tags for the storage pool",
+ "name": "tags",
+ "type": "string"
+ },
+ {
"description": "IOPS CloudStack can provision from this storage pool",
"name": "capacityiops",
"type": "long"
},
- {},
- {
- "description": "true if this pool is suitable to migrate a volume, false otherwise",
- "name": "suitableformigration",
- "type": "boolean"
- },
- {
- "description": "the Zone name of the storage pool",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "the Pod name of the storage pool",
- "name": "podname",
- "type": "string"
- },
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
{
- "description": "the host's currently allocated disk size",
- "name": "disksizeallocated",
- "type": "long"
+ "description": "Storage provider for this pool",
+ "name": "provider",
+ "type": "string"
},
{},
{
- "description": "the ID of the cluster for the storage pool",
- "name": "clusterid",
+ "description": "the name of the cluster for the storage pool",
+ "name": "clustername",
"type": "string"
},
{
- "description": "the Pod ID of the storage pool",
- "name": "podid",
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the overprovisionfactor for the storage pool",
+ "name": "overprovisionfactor",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the storage pool path",
+ "name": "path",
+ "type": "string"
+ },
+ {
+ "description": "true if this pool is suitable to migrate a volume, false otherwise",
+ "name": "suitableformigration",
+ "type": "boolean"
+ },
+ {
+ "description": "the hypervisor type of the storage pool",
+ "name": "hypervisor",
"type": "string"
},
{
@@ -32946,15 +33485,21 @@
"name": "storagecapabilities",
"type": "map"
},
+ {},
{
- "description": "the host's currently used disk size",
- "name": "disksizeused",
+ "description": "the total disk size of the storage pool",
+ "name": "disksizetotal",
"type": "long"
},
{
- "description": "the tags for the storage pool",
- "name": "tags",
+ "description": "the storage pool type",
+ "name": "type",
"type": "string"
+ },
+ {
+ "description": "the host's currently allocated disk size",
+ "name": "disksizeallocated",
+ "type": "long"
}
]
},
@@ -32964,6 +33509,13 @@
"name": "updateHypervisorCapabilities",
"params": [
{
+ "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 security group for this hypervisor.",
"length": 255,
"name": "securitygroupenabled",
@@ -32977,47 +33529,36 @@
"related": "listHypervisorCapabilities,updateHypervisorCapabilities",
"required": false,
"type": "uuid"
- },
- {
- "description": "the max number of Guest VMs per host for this hypervisor.",
- "length": 255,
- "name": "maxguestslimit",
- "required": false,
- "type": "long"
}
],
"related": "listHypervisorCapabilities",
"response": [
{
- "description": "the hypervisor version",
- "name": "hypervisorversion",
- "type": "string"
- },
- {
- "description": "the ID of the hypervisor capabilities row",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the maximum number of Data Volumes that can be attached for this hypervisor",
- "name": "maxdatavolumeslimit",
- "type": "integer"
- },
- {
- "description": "the maximum number of guest vms recommended for this hypervisor",
- "name": "maxguestslimit",
- "type": "long"
- },
- {
"description": "the hypervisor type",
"name": "hypervisor",
"type": "hypervisortype"
},
{
+ "description": "the ID of the hypervisor capabilities row",
+ "name": "id",
+ "type": "string"
+ },
+ {},
+ {
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
+ {
+ "description": "true if storage motion is supported",
+ "name": "storagemotionenabled",
+ "type": "boolean"
+ },
+ {
+ "description": "the maximum number of Data Volumes that can be attached for this hypervisor",
+ "name": "maxdatavolumeslimit",
+ "type": "integer"
+ },
{},
{
"description": "the maximum number of Hosts per cluster for this hypervisor",
@@ -33025,20 +33566,24 @@
"type": "integer"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "true if storage motion is supported",
- "name": "storagemotionenabled",
- "type": "boolean"
- },
- {},
- {
"description": "true if security group is supported",
"name": "securitygroupenabled",
"type": "boolean"
+ },
+ {
+ "description": "the maximum number of guest vms recommended for this hypervisor",
+ "name": "maxguestslimit",
+ "type": "long"
+ },
+ {
+ "description": "the hypervisor version",
+ "name": "hypervisorversion",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
}
],
"since": "3.0.0"
@@ -33049,17 +33594,9 @@
"name": "findHostsForMigration",
"params": [
{
- "description": "find hosts to which this VM can be migrated and flag the hosts with enough CPU/RAM to host the VM",
- "length": 255,
- "name": "virtualmachineid",
- "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance",
- "required": true,
- "type": "uuid"
- },
- {
"description": "",
"length": 255,
- "name": "pagesize",
+ "name": "page",
"required": false,
"type": "integer"
},
@@ -33073,17 +33610,25 @@
{
"description": "",
"length": 255,
- "name": "page",
+ "name": "pagesize",
"required": false,
"type": "integer"
+ },
+ {
+ "description": "find hosts to which this VM can be migrated and flag the hosts with enough CPU/RAM to host the VM",
+ "length": 255,
+ "name": "virtualmachineid",
+ "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance",
+ "required": true,
+ "type": "uuid"
}
],
"related": "",
"response": [
{
- "description": "the date and time the host was removed",
- "name": "removed",
- "type": "date"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
{
"description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise",
@@ -33091,13 +33636,113 @@
"type": "boolean"
},
{
+ "description": "the date and time the host was removed",
+ "name": "removed",
+ "type": "date"
+ },
+ {
+ "description": "the Zone ID of the host",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the Pod name of the host",
+ "name": "podname",
+ "type": "string"
+ },
+ {
+ "description": "the host hypervisor",
+ "name": "hypervisor",
+ "type": "hypervisortype"
+ },
+ {
+ "description": "true if migrating a vm to this host requires storage motion, false otherwise",
+ "name": "requiresStorageMotion",
+ "type": "boolean"
+ },
+ {
+ "description": "the host's currently allocated disk size",
+ "name": "disksizeallocated",
+ "type": "long"
+ },
+ {
+ "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"
+ },
+ {
+ "description": "the resource state of the host",
+ "name": "resourcestate",
+ "type": "string"
+ },
+ {
+ "description": "the hypervisor version",
+ "name": "hypervisorversion",
+ "type": "string"
+ },
+ {
+ "description": "the OS category ID of the host",
+ "name": "oscategoryid",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the host's CPU currently allocated",
+ "name": "cpuallocated",
+ "type": "string"
+ },
+ {
"description": "the host type",
"name": "type",
"type": "type"
},
{
- "description": "the OS category name of the host",
- "name": "oscategoryname",
+ "description": "the Zone name of the host",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "comma-separated list of tags for the host",
+ "name": "hosttags",
+ "type": "string"
+ },
+ {
+ "description": "the total disk size of the host",
+ "name": "disksizetotal",
+ "type": "long"
+ },
+ {
+ "description": "the Pod ID of the host",
+ "name": "podid",
+ "type": "string"
+ },
+ {
+ "description": "the management server ID of the host",
+ "name": "managementserverid",
+ "type": "long"
+ },
+ {
+ "description": "the cpu average load on the host",
+ "name": "averageload",
+ "type": "long"
+ },
+ {
+ "description": "the amount of the host's memory currently allocated",
+ "name": "memoryallocated",
+ "type": "string"
+ },
+ {
+ "description": "true if the host is disconnected. False otherwise.",
+ "name": "disconnected",
+ "type": "date"
+ },
+ {
+ "description": "the cluster ID of the host",
+ "name": "clusterid",
"type": "string"
},
{
@@ -33106,8 +33751,114 @@
"type": "boolean"
},
{
- "description": "the cluster ID of the host",
- "name": "clusterid",
+ "description": "the cluster type of the cluster that host belongs to",
+ "name": "clustertype",
+ "type": "string"
+ },
+ {
+ "description": "the date and time the host was last pinged",
+ "name": "lastpinged",
+ "type": "date"
+ },
+ {
+ "description": "the name of the host",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the state of the host",
+ "name": "state",
+ "type": "status"
+ },
+ {
+ "description": "events available for the host",
+ "name": "events",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor ",
+ "name": "cpuwithoverprovisioning",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "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 ID of the host",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the host's memory currently used",
+ "name": "memoryused",
+ "type": "long"
+ },
+ {
+ "description": "the amount of the host's CPU currently allocated in percentage",
+ "name": "cpuallocatedpercentage",
+ "type": "string"
+ },
+ {
+ "description": "the OS category name of the host",
+ "name": "oscategoryname",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the host version",
+ "name": "version",
+ "type": "string"
+ },
+ {
+ "description": "the CPU number of the host",
+ "name": "cpunumber",
+ "type": "integer"
+ },
+ {
+ "description": "true if local storage is active, false otherwise",
+ "name": "islocalstorageactive",
+ "type": "boolean"
+ },
+ {
+ "description": "the outgoing network traffic on the host",
+ "name": "networkkbswrite",
+ "type": "long"
+ },
+ {
+ "description": "the cluster name of the host",
+ "name": "clustername",
+ "type": "string"
+ },
+ {
+ "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning",
+ "name": "memorytotal",
+ "type": "long"
+ },
+ {
+ "description": "the amount of the host's memory currently allocated in percentage",
+ "name": "memoryallocatedpercentage",
+ "type": "string"
+ },
+ {
+ "description": "the CPU speed of the host",
+ "name": "cpuspeed",
+ "type": "long"
+ },
+ {
+ "description": "the date and time the host was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the IP address of the host",
+ "name": "ipaddress",
"type": "string"
},
{
@@ -33121,227 +33872,21 @@
"type": "string"
},
{
- "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 incoming network traffic on the host",
- "name": "networkkbsread",
- "type": "long"
- },
- {
- "description": "the hypervisor version",
- "name": "hypervisorversion",
- "type": "string"
- },
- {
- "description": "the resource state of the host",
- "name": "resourcestate",
- "type": "string"
- },
- {
- "description": "the cpu average load on the host",
- "name": "averageload",
- "type": "long"
- },
- {
- "description": "the amount of the host's memory currently allocated in percentage",
- "name": "memoryallocatedpercentage",
- "type": "string"
- },
- {
- "description": "the host's currently allocated disk size",
- "name": "disksizeallocated",
- "type": "long"
- },
- {
- "description": "the host version",
- "name": "version",
- "type": "string"
- },
- {
- "description": "the amount of the host's memory currently used",
- "name": "memoryused",
- "type": "long"
- },
- {
- "description": "the Pod name of the host",
- "name": "podname",
- "type": "string"
- },
- {
- "description": "the cluster type of the cluster that host belongs to",
- "name": "clustertype",
- "type": "string"
- },
- {
- "description": "the amount of the host's CPU currently allocated",
- "name": "cpuallocated",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the date and time the host was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the amount of the host's CPU currently used",
- "name": "cpuused",
- "type": "string"
- },
- {
- "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor ",
- "name": "cpuwithoverprovisioning",
- "type": "string"
- },
- {
"description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor",
"name": "cpuallocatedwithoverprovisioning",
"type": "string"
},
{
- "description": "the IP address of the host",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "description": "the cluster name of the host",
- "name": "clustername",
- "type": "string"
- },
- {
- "description": "the CPU number of the host",
- "name": "cpunumber",
- "type": "integer"
- },
- {
- "description": "the ID of the host",
- "name": "id",
- "type": "string"
- },
- {
- "description": "true if the host is disconnected. False otherwise.",
- "name": "disconnected",
- "type": "date"
- },
- {
- "description": "comma-separated list of tags for the host",
- "name": "hosttags",
- "type": "string"
- },
- {
- "description": "the date and time the host was last pinged",
- "name": "lastpinged",
- "type": "date"
- },
- {
- "description": "the OS category ID of the host",
- "name": "oscategoryid",
- "type": "string"
- },
- {
- "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",
- "type": "long"
- },
- {
- "description": "the outgoing network traffic on the host",
- "name": "networkkbswrite",
- "type": "long"
- },
- {
- "description": "the amount of the host's memory after applying the mem.overprovisioning.factor ",
- "name": "memorywithoverprovisioning",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "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 management server ID of the host",
- "name": "managementserverid",
- "type": "long"
- },
- {},
- {
- "description": "the amount of the host's memory currently allocated",
- "name": "memoryallocated",
+ "description": "the amount of the host's CPU currently used",
+ "name": "cpuused",
"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": "hypervisortype"
- },
- {
- "description": "events available for the host",
- "name": "events",
- "type": "string"
- },
- {
- "description": "the amount of the host's CPU currently allocated in percentage",
- "name": "cpuallocatedpercentage",
- "type": "string"
- },
- {
- "description": "the Zone ID of the host",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise",
- "name": "suitableformigration",
- "type": "boolean"
- },
- {
- "description": "the name of the host",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the total disk size of the host",
- "name": "disksizetotal",
- "type": "long"
- },
- {
- "description": "the Zone name of the host",
- "name": "zonename",
- "type": "string"
- }
+ {}
]
},
{
@@ -33361,13 +33906,13 @@
"related": "listCiscoNexusVSMs,disableCiscoNexusVSM",
"response": [
{
- "description": "device state",
- "name": "vsmdevicestate",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
- "description": "The mode of the VSM (standalone/HA)",
- "name": "vsmconfigmode",
+ "description": "The Config State (Primary/Standby) of the VSM",
+ "name": "vsmconfigstate",
"type": "string"
},
{
@@ -33376,50 +33921,45 @@
"type": "string"
},
{
- "description": "device id of the Cisco N1KV VSM device",
- "name": "vsmdeviceid",
- "type": "string"
- },
- {},
- {
- "description": "packet vlan id of the VSM",
- "name": "vsmpktvlanid",
- "type": "int"
- },
- {
- "description": "control vlan id of the VSM",
- "name": "vsmctrlvlanid",
- "type": "int"
- },
- {
- "description": "The Config State (Primary/Standby) of the VSM",
- "name": "vsmconfigstate",
- "type": "string"
- },
- {},
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "management vlan id of the VSM",
- "name": "vsmmgmtvlanid",
- "type": "string"
- },
- {
- "description": "The Device State (Enabled/Disabled) of the VSM",
+ "description": "device state",
"name": "vsmdevicestate",
"type": "string"
},
{
+ "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
"description": "storage vlan id of the VSM",
"name": "vsmstoragevlanid",
"type": "int"
},
{
- "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module",
- "name": "ipaddress",
+ "description": "control vlan id of the VSM",
+ "name": "vsmctrlvlanid",
+ "type": "int"
+ },
+ {},
+ {
+ "description": "device id of the Cisco N1KV VSM device",
+ "name": "vsmdeviceid",
+ "type": "string"
+ },
+ {
+ "description": "packet vlan id of the VSM",
+ "name": "vsmpktvlanid",
+ "type": "int"
+ },
+ {},
+ {
+ "description": "The mode of the VSM (standalone/HA)",
+ "name": "vsmconfigmode",
+ "type": "string"
+ },
+ {
+ "description": "The Device State (Enabled/Disabled) of the VSM",
+ "name": "vsmdevicestate",
"type": "string"
},
{
@@ -33428,9 +33968,14 @@
"type": "string"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "management vlan id of the VSM",
+ "name": "vsmmgmtvlanid",
"type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
}
]
},
@@ -33440,12 +33985,11 @@
"name": "dedicateGuestVlanRange",
"params": [
{
- "description": "physical network ID of the vlan",
+ "description": "guest vlan range to be dedicated",
"length": 255,
- "name": "physicalnetworkid",
- "related": "createPhysicalNetwork",
+ "name": "vlanrange",
"required": true,
- "type": "uuid"
+ "type": "string"
},
{
"description": "project who will own the VLAN",
@@ -33456,11 +34000,12 @@
"type": "uuid"
},
{
- "description": "account who will own the VLAN",
+ "description": "physical network ID of the vlan",
"length": 255,
- "name": "account",
- "required": false,
- "type": "string"
+ "name": "physicalnetworkid",
+ "related": "createPhysicalNetwork",
+ "required": true,
+ "type": "uuid"
},
{
"description": "domain ID of the account owning a VLAN",
@@ -33471,23 +34016,33 @@
"type": "uuid"
},
{
- "description": "guest vlan range to be dedicated",
+ "description": "account who will own the VLAN",
"length": 255,
- "name": "vlanrange",
- "required": true,
+ "name": "account",
+ "required": false,
"type": "string"
}
],
"related": "listDedicatedGuestVlanRanges",
"response": [
{
+ "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 zone of the guest vlan range",
"name": "zoneid",
"type": "long"
},
{
- "description": "the ID of the guest VLAN range",
- "name": "id",
+ "description": "the project id of the guest vlan range",
+ "name": "projectid",
"type": "string"
},
{
@@ -33502,15 +34057,21 @@
},
{},
{
+ "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 project name of the guest vlan range",
"name": "project",
"type": "string"
},
- {
- "description": "the domain ID of the guest VLAN range",
- "name": "domainid",
- "type": "string"
- },
+ {},
{
"description": "the physical network of the guest vlan range",
"name": "physicalnetworkid",
@@ -33520,23 +34081,7 @@
"description": "the domain name of the guest VLAN range",
"name": "domain",
"type": "string"
- },
- {
- "description": "the project id of the guest vlan range",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the account of the guest VLAN range",
- "name": "account",
- "type": "string"
- },
- {}
+ }
]
},
{
@@ -33545,14 +34090,6 @@
"name": "addNicToVirtualMachine",
"params": [
{
- "description": "Network ID",
- "length": 255,
- "name": "networkid",
- "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks",
- "required": true,
- "type": "uuid"
- },
- {
"description": "IP Address for the new network",
"length": 255,
"name": "ipaddress",
@@ -33560,6 +34097,13 @@
"type": "string"
},
{
+ "description": "DHCP options which are passed to the nic Example: dhcpoptions[0].dhcp:114=url&dhcpoptions[0].dhcp:66=www.test.com",
+ "length": 255,
+ "name": "dhcpoptions",
+ "required": false,
+ "type": "map"
+ },
+ {
"description": "Virtual Machine ID",
"length": 255,
"name": "virtualmachineid",
@@ -33568,244 +34112,46 @@
"type": "uuid"
},
{
+ "description": "Network ID",
+ "length": 255,
+ "name": "networkid",
+ "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks",
+ "required": true,
+ "type": "uuid"
+ },
+ {
"description": "Mac Address for the new network",
"length": 255,
"name": "macaddress",
"required": false,
"type": "string"
- },
- {
- "description": "DHCP options which are passed to the nic Example: dhcpoptions[0].dhcp:114=url&dhcpoptions[0].dhcp:66=www.test.com",
- "length": 255,
- "name": "dhcpoptions",
- "required": false,
- "type": "map"
}
],
"related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance",
"response": [
{
- "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 ID of the disk offering of the virtual machine",
- "name": "diskofferingid",
- "type": "string"
- },
- {
- "description": "instance name of the user vm; this parameter is returned to the ROOT admin only",
- "name": "instancename",
- "type": "string"
- },
- {
- "description": "the target memory in vm",
- "name": "memorytargetkbs",
- "type": "long"
- },
- {
- "description": "true if the password rest feature is enabled, false otherwise",
- "name": "passwordenabled",
- "type": "boolean"
- },
- {
- "description": "the ID of the domain in which the virtual machine exists",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the outgoing network traffic on the host",
- "name": "networkkbswrite",
- "type": "long"
- },
- {},
- {
- "description": "the date when this virtual machine was updated last time",
- "name": "lastupdated",
- "type": "date"
- },
- {
- "description": "the group name of the virtual machine",
- "name": "group",
- "type": "string"
- },
- {
- "description": "an optional field whether to the display the vm to the end user or not.",
- "name": "displayvm",
- "type": "boolean"
- },
- {
- "description": "the ID of the virtual machine",
- "name": "id",
- "type": "string"
- },
- {
"description": "the total number of network traffic bytes sent",
"name": "sentbytes",
"type": "long"
},
{
- "description": "Guest vm Boot Type",
- "name": "boottype",
+ "description": "the account associated with the virtual machine",
+ "name": "account",
"type": "string"
},
{
- "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": "public IP address id associated with vm via Static nat rule",
- "name": "publicipid",
+ "description": "the vgpu type used by the virtual machine",
+ "name": "vgpu",
"type": "string"
},
{
- "description": "the list of nics associated with vm",
- "name": "nic",
- "response": [
- {
- "description": "the ip address of the nic",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "description": "the cidr of IPv6 network",
- "name": "ip6cidr",
- "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": "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 isolation uri of the nic",
- "name": "isolationuri",
- "type": "string"
- },
- {
- "description": "device id for the network when plugged into the virtual machine",
- "name": "deviceid",
- "type": "string"
- },
- {
- "description": "the isolated private VLAN if available",
- "name": "isolatedpvlan",
- "type": "integer"
- },
- {
- "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 Secondary ipv4 addr of nic",
- "name": "secondaryip",
- "type": "list"
- },
- {
- "description": "the ID of the nic",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the traffic type of the nic",
- "name": "traffictype",
- "type": "string"
- },
- {
- "description": "the gateway of the nic",
- "name": "gateway",
- "type": "string"
- },
- {
- "description": "the IPv6 address of network",
- "name": "ip6address",
- "type": "string"
- },
- {
- "description": "ID of the VLAN/VNI if available",
- "name": "vlanid",
- "type": "integer"
- },
- {
- "description": "the isolated private VLAN type if available",
- "name": "isolatedpvlantype",
- "type": "string"
- },
- {
- "description": "the ID of the corresponding network",
- "name": "networkid",
- "type": "string"
- },
- {
- "description": "the netmask of the nic",
- "name": "netmask",
- "type": "string"
- },
- {
- "description": "the 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": "Type of adapter if available",
- "name": "adaptertype",
- "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": "Id of the NSX Logical Switch Port (if NSX based), null otherwise",
- "name": "nsxlogicalswitchport",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "OS type id of the vm",
- "name": "ostypeid",
+ "description": "the name of the availability zone for the virtual machine",
+ "name": "zonename",
"type": "string"
},
{
@@ -33814,109 +34160,9 @@
"type": "long"
},
{
- "description": "the project id of the vm",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the amount of the vm's CPU currently used",
- "name": "cpuused",
- "type": "string"
- },
- {
- "description": "Guest vm Boot Mode",
- "name": "bootmode",
- "type": "string"
- },
- {
- "description": "the total number of network traffic bytes received",
- "name": "receivedbytes",
- "type": "long"
- },
- {
- "description": "the ID of the service offering of the virtual machine",
- "name": "serviceofferingid",
- "type": "string"
- },
- {
- "description": "the ID of the ISO attached to the virtual machine",
- "name": "isoid",
- "type": "string"
- },
- {
- "description": "the group ID of the virtual machine",
- "name": "groupid",
- "type": "string"
- },
- {
- "description": "the write (bytes) of disk on the vm",
- "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": "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",
- "type": "string"
- },
- {
- "description": "the name of the backup offering of the virtual machine",
- "name": "backupofferingname",
- "type": "string"
- },
- {
- "description": "the name of the ISO attached to the virtual machine",
- "name": "isoname",
- "type": "string"
- },
- {
- "description": "the project name of the vm",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the hypervisor on which the template runs",
- "name": "hypervisor",
- "type": "string"
- },
- {
- "description": "the name of the virtual machine",
- "name": "name",
- "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 number of cpu this virtual machine is running with",
- "name": "cpunumber",
- "type": "integer"
- },
- {
- "description": "OS name of the vm",
- "name": "osdisplayname",
- "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 name of the domain in which the virtual machine exists",
@@ -33924,324 +34170,197 @@
"type": "string"
},
{
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
- },
- {
- "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 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 ID of the availablility zone for the virtual machine",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the vgpu type used by the virtual machine",
- "name": "vgpu",
- "type": "string"
- },
- {},
- {
- "description": "the name of the disk offering of the virtual machine",
- "name": "diskofferingname",
- "type": "string"
- },
- {
- "description": "the name of the service offering of the virtual machine",
- "name": "serviceofferingname",
- "type": "string"
- },
- {
- "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.",
- "name": "isdynamicallyscalable",
- "type": "boolean"
- },
- {
- "description": "device type of the root volume",
- "name": "rootdevicetype",
- "type": "string"
- },
- {
- "description": "the password (if exists) of the virtual machine",
- "name": "password",
- "type": "string"
- },
- {
- "description": "Os type ID of the virtual machine",
- "name": "guestosid",
- "type": "string"
- },
- {
- "description": "the read (bytes) of disk on the vm",
- "name": "diskkbsread",
+ "description": "the outgoing network traffic on the host",
+ "name": "networkkbswrite",
"type": "long"
},
{
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
+ "description": "the date when this virtual machine was created",
+ "name": "created",
+ "type": "date"
},
{
- "description": "the virtual network for the service offering",
- "name": "forvirtualnetwork",
- "type": "boolean"
+ "description": "the group ID of the virtual machine",
+ "name": "groupid",
+ "type": "string"
+ },
+ {
+ "description": "the user's ID who deployed the virtual machine",
+ "name": "userid",
+ "type": "string"
+ },
+ {
+ "description": "the list of nics associated with vm",
+ "name": "nic",
+ "response": [
+ {
+ "description": "the name of the corresponding network",
+ "name": "networkname",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the nic",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "Id of the vm to which the nic belongs",
+ "name": "virtualmachineid",
+ "type": "string"
+ },
+ {
+ "description": "the isolation uri of the nic",
+ "name": "isolationuri",
+ "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 ip address of the nic",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "device id for the network when plugged into the virtual machine",
+ "name": "deviceid",
+ "type": "string"
+ },
+ {
+ "description": "true if nic is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {
+ "description": "the type of the nic",
+ "name": "type",
+ "type": "string"
+ },
+ {
+ "description": "the cidr of IPv6 network",
+ "name": "ip6cidr",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the corresponding network",
+ "name": "networkid",
+ "type": "string"
+ },
+ {
+ "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise",
+ "name": "nsxlogicalswitchport",
+ "type": "string"
+ },
+ {
+ "description": "the gateway of IPv6 network",
+ "name": "ip6gateway",
+ "type": "string"
+ },
+ {
+ "description": "the netmask of the nic",
+ "name": "netmask",
+ "type": "string"
+ },
+ {
+ "description": "true if nic is default, false otherwise",
+ "name": "macaddress",
+ "type": "string"
+ },
+ {
+ "description": "the 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 Secondary ipv4 addr of nic",
+ "name": "secondaryip",
+ "type": "list"
+ },
+ {
+ "description": "the isolated private VLAN if available",
+ "name": "isolatedpvlan",
+ "type": "integer"
+ },
+ {
+ "description": "the broadcast uri of the nic",
+ "name": "broadcasturi",
+ "type": "string"
+ },
+ {
+ "description": "the gateway of the nic",
+ "name": "gateway",
+ "type": "string"
+ },
+ {
+ "description": "the 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 IPv6 address of network",
+ "name": "ip6address",
+ "type": "string"
+ },
+ {
+ "description": "the extra dhcp options on the nic",
+ "name": "extradhcpoption",
+ "type": "list"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "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": "list of security groups associated with the virtual machine",
"name": "securitygroup",
"response": [
{
+ "description": "the ID of the security group",
+ "name": "id",
+ "type": "string"
+ },
+ {
"description": "the description of the security group",
"name": "description",
"type": "string"
},
{
- "description": "the number of virtualmachines associated with this securitygroup",
- "name": "virtualmachinecount",
- "type": "integer"
- },
- {
- "description": "the project id of the group",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the list of egress rules associated with the security group",
- "name": "egressrule",
- "response": [
- {
- "description": "the type of the ICMP message response",
- "name": "icmptype",
- "type": "integer"
- },
- {
- "description": "the CIDR notation for the base IP address of the security group rule",
- "name": "cidr",
- "type": "string"
- },
- {
- "description": "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 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 domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the 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": "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 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": "account owning the security group rule",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the type of the ICMP message response",
- "name": "icmptype",
- "type": "integer"
- },
- {
- "description": "the list of resource tags associated with the rule",
- "name": "tags",
- "response": [
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "the 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 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"
- }
- ],
- "type": "set"
- },
- {
- "description": "the CIDR notation for the base IP address of the security group rule",
- "name": "cidr",
- "type": "string"
- },
- {
- "description": "security group name",
- "name": "securitygroupname",
- "type": "string"
- },
- {
- "description": "the id of the security group rule",
- "name": "ruleid",
- "type": "string"
- },
- {
- "description": "the protocol of the security group rule",
- "name": "protocol",
- "type": "string"
- },
- {
- "description": "the ending IP of the security group rule ",
- "name": "endport",
- "type": "integer"
- },
- {
- "description": "the 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 project name of the group",
"name": "project",
"type": "string"
@@ -34252,11 +34371,6 @@
"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"
@@ -34267,17 +34381,17 @@
"type": "string"
},
{
+ "description": "the number of virtualmachines associated with this securitygroup",
+ "name": "virtualmachinecount",
+ "type": "integer"
+ },
+ {
"description": "the list of resource tags associated with the rule",
"name": "tags",
"response": [
{
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
+ "description": "the account associated with the tag",
+ "name": "account",
"type": "string"
},
{
@@ -34286,18 +34400,18 @@
"type": "string"
},
{
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
"description": "tag value",
"name": "value",
"type": "string"
},
{
- "description": "customer associated with the tag",
- "name": "customer",
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
"type": "string"
},
{
@@ -34306,69 +34420,352 @@
"type": "string"
},
{
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
+ "description": "the project name where tag belongs to",
+ "name": "project",
"type": "string"
},
{
"description": "the ID of the domain associated with the tag",
"name": "domainid",
"type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
}
],
"type": "set"
},
{
- "description": "the ID of the security group",
- "name": "id",
+ "description": "the project id of the group",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the list of ingress rules associated with the security group",
+ "name": "ingressrule",
+ "response": [
+ {
+ "description": "the type of the ICMP message response",
+ "name": "icmptype",
+ "type": "integer"
+ },
+ {
+ "description": "the starting IP of the security group rule",
+ "name": "startport",
+ "type": "integer"
+ },
+ {
+ "description": "the list of resource tags associated with the rule",
+ "name": "tags",
+ "response": [
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "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 project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "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 code for the ICMP message response",
+ "name": "icmpcode",
+ "type": "integer"
+ },
+ {
+ "description": "the CIDR notation for the base IP address of the security group rule",
+ "name": "cidr",
+ "type": "string"
+ },
+ {
+ "description": "account owning the security group rule",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the ending IP of the security group rule ",
+ "name": "endport",
+ "type": "integer"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the list of egress rules associated with the security group",
+ "name": "egressrule",
+ "response": [
+ {
+ "description": "the starting IP of the security group rule",
+ "name": "startport",
+ "type": "integer"
+ },
+ {
+ "description": "the CIDR notation for the base IP address of the security group rule",
+ "name": "cidr",
+ "type": "string"
+ },
+ {
+ "description": "the code for the ICMP message response",
+ "name": "icmpcode",
+ "type": "integer"
+ },
+ {
+ "description": "the id of the security group rule",
+ "name": "ruleid",
+ "type": "string"
+ },
+ {
+ "description": "security group name",
+ "name": "securitygroupname",
+ "type": "string"
+ },
+ {
+ "description": "the list of resource tags associated with the rule",
+ "name": "tags",
+ "response": [
+ {
+ "description": "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 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": "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": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the ending IP of the security group rule ",
+ "name": "endport",
+ "type": "integer"
+ },
+ {
+ "description": "the protocol of the security group rule",
+ "name": "protocol",
+ "type": "string"
+ },
+ {
+ "description": "account owning the security group rule",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the type of the ICMP message response",
+ "name": "icmptype",
+ "type": "integer"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the name of the security group",
+ "name": "name",
"type": "string"
}
],
"type": "set"
},
{
- "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.",
- "name": "templateid",
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "description": "the incoming network traffic on the vm",
+ "name": "networkkbsread",
+ "type": "long"
+ },
+ {
+ "description": "the name of the backup offering of the virtual machine",
+ "name": "backupofferingname",
"type": "string"
},
{
- "description": "the name of the host for the virtual machine",
- "name": "hostname",
+ "description": "the ID of the disk offering of the virtual machine",
+ "name": "diskofferingid",
"type": "string"
},
{
- "description": "the user's ID who deployed the virtual machine",
- "name": "userid",
+ "description": "user generated name. The name of the virtual machine is returned if no displayname exists.",
+ "name": "displayname",
"type": "string"
},
{
- "description": "the speed of each cpu",
- "name": "cpuspeed",
- "type": "integer"
+ "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 ID of the availablility zone for the virtual machine",
+ "name": "zoneid",
"type": "string"
},
{
+ "description": "List of read-only Vm details as comma separated string.",
+ "name": "readonlydetails",
+ "type": "string"
+ },
+ {
+ "description": "OS name of the vm",
+ "name": "osdisplayname",
+ "type": "string"
+ },
+ {
+ "description": "instance name of the user vm; this parameter is returned to the ROOT admin only",
+ "name": "instancename",
+ "type": "string"
+ },
+ {
+ "description": "State of the Service from LB rule",
+ "name": "servicestate",
+ "type": "string"
+ },
+ {
+ "description": "the total number of network traffic bytes received",
+ "name": "receivedbytes",
+ "type": "long"
+ },
+ {
+ "description": "the write (io) of disk on the vm",
+ "name": "diskiowrite",
+ "type": "long"
+ },
+ {
+ "description": "the target memory in vm",
+ "name": "memorytargetkbs",
+ "type": "long"
+ },
+ {
+ "description": "the project id of the vm",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "Vm details in key/value pairs.",
+ "name": "details",
+ "type": "map"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
"description": "ssh key-pair",
"name": "keypair",
"type": "string"
},
{
- "description": "true if high-availability is enabled, false otherwise",
- "name": "haenable",
- "type": "boolean"
- },
- {
- "description": "the pool type of the virtual machine",
- "name": "pooltype",
+ "description": "public IP address id associated with vm via Static nat rule",
+ "name": "publicip",
"type": "string"
},
{
@@ -34376,6 +34773,26 @@
"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": "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"
@@ -34386,23 +34803,8 @@
"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",
+ "description": "tag key name",
+ "name": "key",
"type": "string"
},
{
@@ -34419,21 +34821,158 @@
"description": "the project name where tag belongs to",
"name": "project",
"type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
}
],
"type": "set"
},
+ {},
+ {
+ "description": "the memory used by the vm",
+ "name": "memorykbs",
+ "type": "long"
+ },
+ {
+ "description": "the read (bytes) of disk on the vm",
+ "name": "diskkbsread",
+ "type": "long"
+ },
+ {
+ "description": "device ID of the root volume",
+ "name": "rootdeviceid",
+ "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",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the backup offering of the virtual machine",
+ "name": "backupofferingid",
+ "type": "string"
+ },
+ {
+ "description": "the number of cpu this virtual machine is running with",
+ "name": "cpunumber",
+ "type": "integer"
+ },
+ {
+ "description": "the name of the ISO attached to the virtual machine",
+ "name": "isoname",
+ "type": "string"
+ },
+ {
+ "description": "the name of the host for the virtual machine",
+ "name": "hostname",
+ "type": "string"
+ },
+ {
+ "description": "Guest vm Boot Mode",
+ "name": "bootmode",
+ "type": "string"
+ },
+ {
+ "description": "the user's name who deployed the virtual machine",
+ "name": "username",
+ "type": "string"
+ },
+ {
+ "description": "the 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 ID of the host for the virtual machine",
+ "name": "hostid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.",
+ "name": "templateid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "device type of the root volume",
+ "name": "rootdevicetype",
+ "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 speed of each cpu",
+ "name": "cpuspeed",
+ "type": "integer"
+ },
+ {
+ "description": "the write (bytes) of disk on the vm",
+ "name": "diskkbswrite",
+ "type": "long"
+ },
+ {
+ "description": "the project name of the vm",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the name of the disk offering of the virtual machine",
+ "name": "diskofferingname",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain in which the virtual machine exists",
+ "name": "domainid",
+ "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 amount of the vm's CPU currently used",
+ "name": "cpuused",
+ "type": "string"
+ },
+ {
+ "description": "OS type id of the vm",
+ "name": "ostypeid",
+ "type": "string"
+ },
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
{
+ "description": "the state of the virtual machine",
+ "name": "state",
+ "type": "string"
+ },
+ {
"description": "list of affinity groups associated with the virtual machine",
"name": "affinitygroup",
"response": [
@@ -34443,11 +34982,41 @@
"type": "string"
},
{
+ "description": "the type of the affinity group",
+ "name": "type",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID of the affinity group",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "virtual machine IDs associated with this affinity group",
+ "name": "virtualmachineIds",
+ "type": "list"
+ },
+ {
+ "description": "the name of the affinity group",
+ "name": "name",
+ "type": "string"
+ },
+ {
"description": "the domain name of the affinity group",
"name": "domain",
"type": "string"
},
{
+ "description": "the description of the affinity group",
+ "name": "description",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the affinity group",
+ "name": "project",
+ "type": "string"
+ },
+ {
"description": "the account owning the affinity group",
"name": "account",
"type": "string"
@@ -34456,84 +35025,60 @@
"description": "the project ID of the affinity group",
"name": "projectid",
"type": "string"
- },
- {
- "description": "the name of the affinity group",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the domain ID of the affinity group",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the project name of the affinity group",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the type of the affinity group",
- "name": "type",
- "type": "string"
- },
- {
- "description": "the description of the affinity group",
- "name": "description",
- "type": "string"
- },
- {
- "description": "virtual machine IDs associated with this affinity group",
- "name": "virtualmachineIds",
- "type": "list"
}
],
"type": "set"
},
{
+ "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",
+ "type": "string"
+ },
+ {
+ "description": "the pool type of the virtual machine",
+ "name": "pooltype",
+ "type": "string"
+ },
+ {
"description": " an alternate display text of the template for the virtual machine",
"name": "templatedisplaytext",
"type": "string"
},
{
- "description": "the write (io) of disk on the vm",
- "name": "diskiowrite",
- "type": "long"
+ "description": "the name of the template for the virtual machine",
+ "name": "templatename",
+ "type": "string"
},
+ {},
{
- "description": "the ID of the host for the virtual machine",
- "name": "hostid",
+ "description": "the password (if exists) of the virtual machine",
+ "name": "password",
"type": "string"
},
{
- "description": "the memory used by the vm",
- "name": "memorykbs",
- "type": "long"
- },
- {
- "description": "the incoming network traffic on the vm",
- "name": "networkkbsread",
- "type": "long"
- },
- {
- "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": "device ID of the root volume",
- "name": "rootdeviceid",
- "type": "long"
- },
- {
- "description": "the account associated with the virtual machine",
- "name": "account",
+ "description": "Os type ID of the virtual machine",
+ "name": "guestosid",
"type": "string"
},
{
- "description": "an alternate display text of the ISO attached to the virtual machine",
- "name": "isodisplaytext",
+ "description": "the group name of the virtual machine",
+ "name": "group",
"type": "string"
+ },
+ {
+ "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.",
+ "name": "isdynamicallyscalable",
+ "type": "boolean"
}
]
},
@@ -34543,6 +35088,57 @@
"name": "listStaticRoutes",
"params": [
{
+ "description": "list static route by id",
+ "length": 255,
+ "name": "id",
+ "related": "listStaticRoutes",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "list only resources belonging to the domain specified",
+ "length": 255,
+ "name": "domainid",
+ "related": "createDomain,listDomainChildren,listDomains,listDomains",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "list static routes by state",
+ "length": 255,
+ "name": "state",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "List resources by tags (key/value pairs)",
+ "length": 255,
+ "name": "tags",
+ "required": false,
+ "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",
+ "length": 255,
+ "name": "listall",
+ "required": false,
+ "type": "boolean"
+ },
+ {
"description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
"length": 255,
"name": "isrecursive",
@@ -34558,21 +35154,6 @@
"type": "uuid"
},
{
- "description": "List resources by tags (key/value pairs)",
- "length": 255,
- "name": "tags",
- "required": false,
- "type": "map"
- },
- {
- "description": "list only resources belonging to the domain specified",
- "length": 255,
- "name": "domainid",
- "related": "createDomain,listDomainChildren,listDomains,listDomains",
- "required": false,
- "type": "uuid"
- },
- {
"description": "list resources by account. Must be used with the domainId parameter.",
"length": 255,
"name": "account",
@@ -34580,50 +35161,6 @@
"type": "string"
},
{
- "description": "list objects by project",
- "length": 255,
- "name": "projectid",
- "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "list static route by id",
- "length": 255,
- "name": "id",
- "related": "listStaticRoutes",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
- },
- {
- "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false",
- "length": 255,
- "name": "listall",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "",
- "length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
- },
- {
- "description": "list static routes by state",
- "length": 255,
- "name": "state",
- "required": false,
- "type": "string"
- },
- {
"description": "",
"length": 255,
"name": "page",
@@ -34631,6 +35168,14 @@
"type": "integer"
},
{
+ "description": "list objects by project",
+ "length": 255,
+ "name": "projectid",
+ "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject",
+ "required": false,
+ "type": "uuid"
+ },
+ {
"description": "list static routes by gateway id",
"length": 255,
"name": "gatewayid",
@@ -34642,32 +35187,44 @@
"related": "",
"response": [
{
+ "description": "VPC gateway the route is created for",
+ "name": "gatewayid",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the static route",
+ "name": "project",
+ "type": "string"
+ },
+ {
"description": "the domain associated with the static route",
"name": "domain",
"type": "string"
},
+ {},
+ {
+ "description": "the account associated with the static route",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {},
+ {
+ "description": "the project id of the static route",
+ "name": "projectid",
+ "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",
- "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",
+ "description": "tag value",
+ "name": "value",
"type": "string"
},
{
@@ -34676,45 +35233,49 @@
"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": "tag value",
- "name": "value",
+ "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 name where tag belongs to",
+ "name": "project",
"type": "string"
},
{
"description": "the project id the tag belongs to",
"name": "projectid",
"type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
}
],
"type": "list"
},
{
- "description": "the account associated with the static route",
- "name": "account",
- "type": "string"
- },
- {},
- {
- "description": "the project name of the static route",
- "name": "project",
- "type": "string"
- },
- {
"description": "static route CIDR",
"name": "cidr",
"type": "string"
@@ -34730,35 +35291,19 @@
"type": "string"
},
{
- "description": "VPC gateway the route is created for",
- "name": "gatewayid",
- "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 state of the static route",
+ "name": "state",
+ "type": "string"
},
{
"description": "VPC the static route belongs to",
"name": "vpcid",
"type": "string"
- },
- {},
- {
- "description": "the project id of the static route",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the state of the static route",
- "name": "state",
- "type": "string"
}
]
},
@@ -34768,20 +35313,73 @@
"name": "listPublicIpAddresses",
"params": [
{
- "description": "lists the specified IP address",
+ "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter",
"length": 255,
- "name": "ipaddress",
+ "name": "fordisplay",
"required": false,
- "type": "string"
+ "since": "4.4",
+ "type": "boolean"
},
{
- "description": "the virtual network for the IP address",
+ "description": "list only IPs used for load balancing",
"length": 255,
- "name": "forvirtualnetwork",
+ "name": "forloadbalancing",
"required": false,
"type": "boolean"
},
{
+ "description": "lists all public IP addresses by physical network ID",
+ "length": 255,
+ "name": "physicalnetworkid",
+ "related": "createPhysicalNetwork",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "list objects by project",
+ "length": 255,
+ "name": "projectid",
+ "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "limits search results to allocated public IP addresses",
+ "length": 255,
+ "name": "allocatedonly",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "lists all public IP addresses associated to the network specified",
+ "length": 255,
+ "name": "associatednetworkid",
+ "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks",
+ "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",
+ "length": 255,
+ "name": "listall",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "lists all public IP addresses by state",
+ "length": 255,
+ "name": "state",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
"length": 255,
"name": "isrecursive",
@@ -34789,6 +35387,29 @@
"type": "boolean"
},
{
+ "description": "list resources by account. Must be used with the domainId parameter.",
+ "length": 255,
+ "name": "account",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "lists all public IP addresses by source network ID",
+ "length": 255,
+ "name": "networkid",
+ "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks",
+ "required": false,
+ "since": "4.13.0",
+ "type": "uuid"
+ },
+ {
"description": "List by keyword",
"length": 255,
"name": "keyword",
@@ -34796,6 +35417,20 @@
"type": "string"
},
{
+ "description": "lists the specified IP address",
+ "length": 255,
+ "name": "ipaddress",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "List resources by tags (key/value pairs)",
+ "length": 255,
+ "name": "tags",
+ "required": false,
+ "type": "map"
+ },
+ {
"description": "lists IP address by ID",
"length": 255,
"name": "id",
@@ -34804,6 +35439,20 @@
"type": "uuid"
},
{
+ "description": "list only source NAT IP addresses",
+ "length": 255,
+ "name": "issourcenat",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "the virtual network for the IP address",
+ "length": 255,
+ "name": "forvirtualnetwork",
+ "required": false,
+ "type": "boolean"
+ },
+ {
"description": "list only static NAT IP addresses",
"length": 255,
"name": "isstaticnat",
@@ -34819,49 +35468,6 @@
"type": "uuid"
},
{
- "description": "List resources by tags (key/value pairs)",
- "length": 255,
- "name": "tags",
- "required": false,
- "type": "map"
- },
- {
- "description": "list resources by account. Must be used with the domainId parameter.",
- "length": 255,
- "name": "account",
- "required": false,
- "type": "string"
- },
- {
- "description": "",
- "length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
- },
- {
- "description": "",
- "length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
- },
- {
- "description": "lists all public IP addresses by physical network ID",
- "length": 255,
- "name": "physicalnetworkid",
- "related": "createPhysicalNetwork",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "limits search results to allocated public IP addresses",
- "length": 255,
- "name": "allocatedonly",
- "required": false,
- "type": "boolean"
- },
- {
"description": "lists all public IP addresses by zone ID",
"length": 255,
"name": "zoneid",
@@ -34878,91 +35484,46 @@
"type": "uuid"
},
{
- "description": "list objects by project",
- "length": 255,
- "name": "projectid",
- "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject",
- "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": "lists all public IP addresses associated to the network specified",
- "length": 255,
- "name": "associatednetworkid",
- "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "list only source NAT IP addresses",
- "length": 255,
- "name": "issourcenat",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "lists all public IP addresses by state",
- "length": 255,
- "name": "state",
- "required": false,
- "type": "string"
- },
- {
- "description": "list only IPs used for load balancing",
- "length": 255,
- "name": "forloadbalancing",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false",
- "length": 255,
- "name": "listall",
- "required": false,
- "type": "boolean"
- },
- {
"description": "list only resources belonging to the domain specified",
"length": 255,
"name": "domainid",
"related": "createDomain,listDomainChildren,listDomains,listDomains",
"required": false,
"type": "uuid"
- },
- {
- "description": "lists all public IP addresses by source network ID",
- "length": 255,
- "name": "networkid",
- "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks",
- "required": false,
- "since": "4.13.0",
- "type": "uuid"
}
],
"related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses",
"response": [
- {
- "description": "the virtual network for the IP address",
- "name": "forvirtualnetwork",
- "type": "boolean"
- },
+ {},
{
"description": "the ID of the zone the public IP address belongs to",
"name": "zoneid",
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "is public IP portable across the zones",
+ "name": "isportable",
+ "type": "boolean"
+ },
+ {
+ "description": "the ID of the Network where ip belongs to",
+ "name": "networkid",
+ "type": "string"
+ },
+ {
+ "description": "the virtual network for the IP address",
+ "name": "forvirtualnetwork",
+ "type": "boolean"
+ },
+ {
+ "description": "virtual machine id the ip address is assigned to (not null only for static nat Ip)",
+ "name": "virtualmachineid",
+ "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",
@@ -34970,6 +35531,16 @@
"type": "string"
},
{
+ "description": "the account the public IP address is associated with",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the project id of the ipaddress",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
"description": "date the public IP address was acquired",
"name": "allocated",
"type": "date"
@@ -34980,48 +35551,28 @@
"type": "string"
},
{
- "description": "the name of the zone the public IP address belongs to",
- "name": "zonename",
- "type": "string"
- },
- {
"description": "public IP address id",
"name": "id",
"type": "string"
},
{
- "description": "the domain the public IP address is associated with",
- "name": "domain",
+ "description": "VPC id the ip belongs to",
+ "name": "vpcid",
"type": "string"
},
{
- "description": "the name of the Network associated with the IP address",
- "name": "associatednetworkname",
+ "description": "VPC name the ip belongs to",
+ "name": "vpcname",
"type": "string"
},
{
- "description": "the physical network this belongs to",
- "name": "physicalnetworkid",
+ "description": "the project name of the address",
+ "name": "project",
"type": "string"
},
{
- "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",
- "type": "string"
- },
- {
- "description": "is public IP portable across the zones",
- "name": "isportable",
- "type": "boolean"
- },
- {
- "description": "State of the ip address. Can be: Allocatin, Allocated and Releasing",
- "name": "state",
+ "description": "virtual machine (dnat) ip address (not null only for static nat Ip)",
+ "name": "vmipaddress",
"type": "string"
},
{
@@ -35030,32 +35581,67 @@
"type": "string"
},
{
+ "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",
+ "type": "string"
+ },
+ {
+ "description": "the domain the public IP address 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 display name the ip address is assigned to (not null only for static nat Ip)",
"name": "virtualmachinedisplayname",
"type": "string"
},
{
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
+ "description": "the ID of the Network associated with the IP address",
+ "name": "associatednetworkid",
+ "type": "string"
},
{
"description": "the list of resource tags associated with ip address",
"name": "tags",
"response": [
{
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
"description": "resource type",
"name": "resourcetype",
"type": "string"
},
{
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
"description": "customer associated with the tag",
"name": "customer",
"type": "string"
},
{
- "description": "the account associated with the tag",
- "name": "account",
+ "description": "tag value",
+ "name": "value",
"type": "string"
},
{
@@ -35069,113 +35655,72 @@
"type": "string"
},
{
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
"description": "id of the resource",
"name": "resourceid",
"type": "string"
},
{
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
"type": "string"
}
],
"type": "list"
},
{
- "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only",
- "name": "vlanid",
- "type": "string"
- },
- {
- "description": "the ID of the Network where ip belongs to",
- "name": "networkid",
- "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": "true if the IP address is a source nat address, false otherwise",
+ "name": "issourcenat",
+ "type": "boolean"
+ },
+ {
+ "description": "State of the ip address. Can be: Allocatin, Allocated and Releasing",
+ "name": "state",
+ "type": "string"
+ },
{
"description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)",
"name": "issystem",
"type": "boolean"
},
{
- "description": "virtual machine id the ip address is assigned to (not null only for static nat Ip)",
- "name": "virtualmachineid",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "virtual machine (dnat) ip address (not null only for static nat Ip)",
- "name": "vmipaddress",
- "type": "string"
- },
- {
- "description": "the project id of the ipaddress",
- "name": "projectid",
- "type": "string"
- },
- {},
- {
- "description": "public IP address",
- "name": "ipaddress",
- "type": "string"
- },
- {
"description": "the VLAN associated with the IP address",
"name": "vlanname",
"type": "string"
},
{
- "description": "the account the public IP address is associated with",
- "name": "account",
- "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 project name of the address",
- "name": "project",
+ "description": "the physical network this belongs to",
+ "name": "physicalnetworkid",
"type": "string"
},
{
- "description": "true if the IP address is a source nat address, false otherwise",
- "name": "issourcenat",
- "type": "boolean"
+ "description": "the name of the Network associated with the IP address",
+ "name": "associatednetworkname",
+ "type": "string"
},
{
- "description": "VPC id the ip belongs to",
- "name": "vpcid",
+ "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": "public IP address",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only",
+ "name": "vlanid",
"type": "string"
}
]
@@ -35186,6 +35731,28 @@
"name": "listF5LoadBalancers",
"params": [
{
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "the Physical Network ID",
+ "length": 255,
+ "name": "physicalnetworkid",
+ "related": "createPhysicalNetwork",
+ "required": false,
+ "type": "uuid"
+ },
+ {
"description": "f5 load balancer device ID",
"length": 255,
"name": "lbdeviceid",
@@ -35199,37 +35766,42 @@
"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",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "",
- "length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
}
],
"related": "addF5LoadBalancer",
"response": [
{
+ "description": "name of the provider",
+ "name": "provider",
+ "type": "string"
+ },
+ {
+ "description": "the management IP address of the external load balancer",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
"description": "the private interface of the load balancer",
"name": "privateinterface",
"type": "string"
},
+ {},
+ {
+ "description": "device name",
+ "name": "lbdevicename",
+ "type": "string"
+ },
+ {
+ "description": "true if device is dedicated for an account",
+ "name": "lbdevicededicated",
+ "type": "boolean"
+ },
+ {},
{
"description": "device id of the F5 load balancer",
"name": "lbdeviceid",
@@ -35241,51 +35813,24 @@
"type": "string"
},
{
+ "description": "the physical network to which this F5 device belongs to",
+ "name": "physicalnetworkid",
+ "type": "string"
+ },
+ {
"description": "device state",
"name": "lbdevicestate",
"type": "string"
},
{
- "description": "name of the provider",
- "name": "provider",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
"description": "the public interface of the load balancer",
"name": "publicinterface",
"type": "string"
},
{
- "description": "true if device is dedicated for an account",
- "name": "lbdevicededicated",
- "type": "boolean"
- },
- {},
- {},
- {
- "description": "the management IP address of the external load balancer",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "description": "the physical network to which this F5 device belongs to",
- "name": "physicalnetworkid",
- "type": "string"
- },
- {
"description": "device capacity",
"name": "lbdevicecapacity",
"type": "long"
- },
- {
- "description": "device name",
- "name": "lbdevicename",
- "type": "string"
}
]
},
@@ -35295,34 +35840,6 @@
"name": "updateIso",
"params": [
{
- "description": "sort key of the template, integer",
- "length": 255,
- "name": "sortkey",
- "required": false,
- "type": "integer"
- },
- {
- "description": "true if image is bootable, false otherwise; available only for updateIso API",
- "length": 255,
- "name": "bootable",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "true if the template requres HVM, false otherwise; available only for updateTemplate API",
- "length": 255,
- "name": "requireshvm",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "the display text of the image",
- "length": 4096,
- "name": "displaytext",
- "required": false,
- "type": "string"
- },
- {
"description": "true if the template supports the sshkey upload feature; default is false",
"length": 255,
"name": "sshkeyenabled",
@@ -35330,35 +35847,6 @@
"type": "boolean"
},
{
- "description": "the format for the image",
- "length": 255,
- "name": "format",
- "required": false,
- "type": "string"
- },
- {
- "description": "the ID of the image file",
- "length": 255,
- "name": "id",
- "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos",
- "required": true,
- "type": "uuid"
- },
- {
- "description": "true if the template type is routing i.e., if template is used to deploy router",
- "length": 255,
- "name": "isrouting",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "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 image supports the password reset feature; default is false",
"length": 255,
"name": "passwordenabled",
@@ -35366,13 +35854,28 @@
"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"
},
{
+ "description": "the ID of the OS type that best represents the OS of this image.",
+ "length": 255,
+ "name": "ostypeid",
+ "related": "listOsTypes,addGuestOs",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "true if image is bootable, false otherwise; available only for updateIso API",
+ "length": 255,
+ "name": "bootable",
+ "required": false,
+ "type": "boolean"
+ },
+ {
"description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61",
"length": 255,
"name": "details",
@@ -35380,6 +35883,42 @@
"type": "map"
},
{
+ "description": "the ID of the image file",
+ "length": 255,
+ "name": "id",
+ "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos",
+ "required": true,
+ "type": "uuid"
+ },
+ {
+ "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)",
+ "length": 255,
+ "name": "cleanupdetails",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "sort key of the template, integer",
+ "length": 255,
+ "name": "sortkey",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "true if the template type is routing i.e., if template is used to deploy router",
+ "length": 255,
+ "name": "isrouting",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "true if the template requres HVM, false otherwise; available only for updateTemplate API",
+ "length": 255,
+ "name": "requireshvm",
+ "required": false,
+ "type": "boolean"
+ },
+ {
"description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory",
"length": 255,
"name": "isdynamicallyscalable",
@@ -35387,59 +35926,56 @@
"type": "boolean"
},
{
- "description": "the ID of the OS type that best represents the OS of this image.",
+ "description": "the name of the image file",
"length": 255,
- "name": "ostypeid",
- "related": "listOsTypes,addGuestOs",
+ "name": "name",
"required": false,
- "type": "uuid"
+ "type": "string"
+ },
+ {
+ "description": "the display text of the image",
+ "length": 4096,
+ "name": "displaytext",
+ "required": false,
+ "type": "string"
}
],
"related": "prepareTemplate,listIsos,registerIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos",
"response": [
+ {},
{
- "description": "the account name to which the template belongs",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the project id of the template",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "true if this template is a featured template, false otherwise",
- "name": "isfeatured",
+ "description": "true if template requires HVM enabled, false otherwise",
+ "name": "requireshvm",
"type": "boolean"
},
{
- "description": "the name of the domain to which the template belongs",
- "name": "domain",
- "type": "string"
- },
- {
"description": "VMware only: additional key/value details tied with deploy-as-is template",
"name": "deployasisdetails",
"type": "map"
},
{
- "description": "true if the template is managed across all Zones, false otherwise",
- "name": "crossZones",
- "type": "boolean"
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the account id to which the template belongs",
+ "name": "accountid",
"type": "string"
},
{
- "description": "the size of the template",
- "name": "size",
- "type": "long"
+ "description": "the account name to which the template belongs",
+ "name": "account",
+ "type": "string"
},
{
- "description": "the ID of the OS type for this template.",
- "name": "ostypeid",
+ "description": "the tag of this template",
+ "name": "templatetag",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the zone for this template",
+ "name": "zoneid",
"type": "string"
},
{
@@ -35448,8 +35984,58 @@
"type": "map"
},
{
- "description": "the status of the template",
- "name": "status",
+ "description": "the name of the OS type for this template.",
+ "name": "ostypename",
+ "type": "string"
+ },
+ {
+ "description": "true if this template is a featured template, false otherwise",
+ "name": "isfeatured",
+ "type": "boolean"
+ },
+ {
+ "description": "the date this template was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "if root disk template, then ids of the datas disk templates this template owns",
+ "name": "childtemplates",
+ "type": "set"
+ },
+ {
+ "description": "the ID of the OS type for this template.",
+ "name": "ostypeid",
+ "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": "checksum of the template",
+ "name": "checksum",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the secondary storage host for the template",
+ "name": "hostid",
+ "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"
},
{
@@ -35458,31 +36044,76 @@
"type": "string"
},
{
- "description": "true if this template is a public template, false otherwise",
- "name": "ispublic",
- "type": "boolean"
- },
- {
- "description": "true if the reset password feature is enabled, false otherwise",
- "name": "passwordenabled",
- "type": "boolean"
- },
- {
- "description": "the ID of the zone for this template",
- "name": "zoneid",
+ "description": "the project id of the template",
+ "name": "projectid",
"type": "string"
},
{
+ "description": "the name of the domain to which the template belongs",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "true if the template is managed across all Zones, false otherwise",
+ "name": "crossZones",
+ "type": "boolean"
+ },
+ {
"description": "the format of the template.",
"name": "format",
"type": "imageformat"
},
{
+ "description": "the processor bit size",
+ "name": "bits",
+ "type": "int"
+ },
+ {
+ "description": "the URL which the template/iso is registered from",
+ "name": "url",
+ "type": "string"
+ },
+ {
+ "description": "the template name",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the status of the template",
+ "name": "status",
+ "type": "string"
+ },
+ {
+ "description": "the type of the template",
+ "name": "templatetype",
+ "type": "string"
+ },
+ {
"description": "the template display text",
"name": "displaytext",
"type": "string"
},
{
+ "description": "true if the ISO is bootable, false otherwise",
+ "name": "bootable",
+ "type": "boolean"
+ },
+ {
+ "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": "true if the template is extractable, false otherwise",
+ "name": "isextractable",
+ "type": "boolean"
+ },
+ {
"description": "the date this template was removed",
"name": "removed",
"type": "date"
@@ -35493,72 +36124,31 @@
"type": "integer"
},
{
- "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": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.",
- "name": "deployasis",
+ "description": "true if the reset password feature is enabled, false otherwise",
+ "name": "passwordenabled",
"type": "boolean"
},
{
- "description": "true if template requires HVM enabled, false otherwise",
- "name": "requireshvm",
- "type": "boolean"
- },
- {
- "description": "if Datadisk template, then id of the root disk template this template belongs to",
- "name": "parenttemplateid",
- "type": "string"
- },
- {
"description": "true if the entity/resource has annotations",
"name": "hasannotations",
"type": "boolean"
},
{
- "description": "the processor bit size",
- "name": "bits",
- "type": "int"
- },
- {},
- {
- "description": "the URL which the template/iso is registered from",
- "name": "url",
- "type": "string"
- },
- {
- "description": "the date this template was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "checksum of the template",
- "name": "checksum",
- "type": "string"
- },
- {
- "description": "true if the ISO is bootable, false otherwise",
- "name": "bootable",
- "type": "boolean"
- },
- {
"description": "the template ID",
"name": "id",
"type": "string"
},
{
- "description": "the tag of this template",
- "name": "templatetag",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
- "description": "true if the template is extractable, false otherwise",
- "name": "isextractable",
- "type": "boolean"
- },
- {
"description": "the name of the secondary storage host for the template",
"name": "hostname",
"type": "string"
@@ -35569,8 +36159,13 @@
"type": "long"
},
{
- "description": "the type of the template",
- "name": "templatetype",
+ "description": "true if template is sshkey enabled, false otherwise",
+ "name": "sshkeyenabled",
+ "type": "boolean"
+ },
+ {
+ "description": "the project name of the template",
+ "name": "project",
"type": "string"
},
{
@@ -35579,22 +36174,27 @@
"type": "string"
},
{
+ "description": "true if this template is a public template, false otherwise",
+ "name": "ispublic",
+ "type": "boolean"
+ },
+ {
"description": "the list of resource tags associated",
"name": "tags",
"response": [
{
- "description": "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",
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
"type": "string"
},
{
@@ -35603,6 +36203,11 @@
"type": "string"
},
{
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
"description": "tag value",
"name": "value",
"type": "string"
@@ -35613,93 +36218,33 @@
"type": "string"
},
{
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
"description": "the ID of the domain associated with the tag",
"name": "domainid",
"type": "string"
},
{
- "description": "the project 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"
}
],
"type": "set"
},
{
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
- },
- {
"description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage",
"name": "directdownload",
"type": "boolean"
},
- {
- "description": "the project name of the template",
- "name": "project",
- "type": "string"
- },
- {
- "description": "if root disk template, then ids of the datas disk templates this template owns",
- "name": "childtemplates",
- "type": "set"
- },
- {
- "description": "Lists the download progress of a template across all secondary storages",
- "name": "downloaddetails",
- "type": "list"
- },
- {
- "description": "the 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",
- "type": "boolean"
- },
{},
{
"description": "the ID of the domain to which the template belongs",
"name": "domainid",
"type": "string"
- },
- {
- "description": "true if template is sshkey enabled, false otherwise",
- "name": "sshkeyenabled",
- "type": "boolean"
- },
- {
- "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory",
- "name": "isdynamicallyscalable",
- "type": "boolean"
- },
- {
- "description": "the template name",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the name of the zone for this template",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "the ID of the secondary storage host for the template",
- "name": "hostid",
- "type": "string"
}
]
},
@@ -35709,6 +36254,13 @@
"name": "listExternalLoadBalancers",
"params": [
{
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "zone Id",
"length": 255,
"name": "zoneid",
@@ -35717,11 +36269,11 @@
"type": "uuid"
},
{
- "description": "List by keyword",
+ "description": "",
"length": 255,
- "name": "keyword",
+ "name": "pagesize",
"required": false,
- "type": "string"
+ "type": "integer"
},
{
"description": "",
@@ -35729,65 +36281,48 @@
"name": "page",
"required": false,
"type": "integer"
- },
- {
- "description": "",
- "length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
}
],
"related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost",
"response": [
{
- "description": "the host version",
- "name": "version",
+ "description": "the amount of the host's CPU currently used",
+ "name": "cpuused",
"type": "string"
},
{
+ "description": "the hypervisor version",
+ "name": "hypervisorversion",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor",
+ "name": "cpuwithoverprovisioning",
+ "type": "string"
+ },
+ {
+ "description": "true if local storage is active, false otherwise",
+ "name": "islocalstorageactive",
+ "type": "boolean"
+ },
+ {
+ "description": "the date and time the host was last pinged",
+ "name": "lastpinged",
+ "type": "date"
+ },
+ {
"description": "the host HA information information",
"name": "hostha",
"type": "hostharesponse"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
+ "description": "the host hypervisor",
+ "name": "hypervisor",
+ "type": "hypervisortype"
},
{
- "description": "the incoming network traffic on the host",
- "name": "networkkbsread",
- "type": "long"
- },
- {
- "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise",
- "name": "hasenoughcapacity",
- "type": "boolean"
- },
- {
- "description": "the amount of the host's CPU currently allocated",
- "name": "cpuallocated",
- "type": "string"
- },
- {
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "capabilities of the host",
- "name": "capabilities",
- "type": "string"
- },
- {
- "description": "the amount of the host's CPU currently allocated in MHz",
- "name": "cpuallocatedvalue",
- "type": "long"
- },
- {
- "description": "the name of the host",
- "name": "name",
+ "description": "the amount of the host's memory after applying the mem.overprovisioning.factor",
+ "name": "memorywithoverprovisioning",
"type": "string"
},
{
@@ -35796,114 +36331,69 @@
"type": "outofbandmanagementresponse"
},
{
- "description": "the amount of the host's memory currently allocated in bytes",
- "name": "memoryallocatedbytes",
+ "description": "the total disk size of the host",
+ "name": "disksizetotal",
"type": "long"
},
{
- "description": "the IP address of the host",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "description": "true if the host is disconnected. False otherwise.",
- "name": "disconnected",
- "type": "date"
- },
- {
"description": "the host type",
"name": "type",
"type": "type"
},
{
- "description": "the number of CPU sockets on the host",
- "name": "cpusockets",
- "type": "integer"
+ "description": "the Pod ID of the host",
+ "name": "podid",
+ "type": "string"
},
{
- "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise",
- "name": "suitableformigration",
- "type": "boolean"
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
},
{
- "description": "the OS category name of the host",
- "name": "oscategoryname",
+ "description": "the Zone ID of the host",
+ "name": "zoneid",
"type": "string"
},
{},
{
- "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise",
- "name": "hahost",
+ "description": "the resource state of the host",
+ "name": "resourcestate",
+ "type": "string"
+ },
+ {
+ "description": "events available for the host",
+ "name": "events",
+ "type": "string"
+ },
+ {
+ "description": "the admin that annotated this host",
+ "name": "username",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the host",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
"type": "boolean"
},
{
- "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor",
- "name": "cpuallocatedwithoverprovisioning",
- "type": "string"
- },
- {
- "description": "the Pod ID of the host",
- "name": "podid",
- "type": "string"
- },
- {
"description": "comma-separated list of tags for the host",
"name": "hosttags",
"type": "string"
},
{
- "description": "the cpu average load on the host",
- "name": "cpuloadaverage",
- "type": "double"
- },
- {
- "description": "the resource state of the host",
- "name": "resourcestate",
+ "description": "the amount of the host's memory currently allocated in percentage",
+ "name": "memoryallocatedpercentage",
"type": "string"
},
{
- "description": "the date and time the host was last pinged",
- "name": "lastpinged",
- "type": "date"
- },
- {
- "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 date and time the host was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the date and time the host was removed",
- "name": "removed",
- "type": "date"
- },
- {
- "description": "the OS category ID of the host",
- "name": "oscategoryid",
- "type": "string"
- },
- {
- "description": "the last annotation set on this host by an admin",
- "name": "annotation",
- "type": "string"
- },
- {
- "description": "the host's currently allocated disk size",
- "name": "disksizeallocated",
- "type": "long"
- },
- {
- "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor",
- "name": "cpuwithoverprovisioning",
+ "description": "the Zone name of the host",
+ "name": "zonename",
"type": "string"
},
{
@@ -35915,9 +36405,9 @@
"name": "vgpu",
"response": [
{
- "description": "Model Name of vGPU",
- "name": "vgputype",
- "type": "string"
+ "description": "Maximum displays per user",
+ "name": "maxheads",
+ "type": "long"
},
{
"description": "Maximum X resolution per display",
@@ -35925,28 +36415,28 @@
"type": "long"
},
{
+ "description": "Maximum Y resolution per display",
+ "name": "maxresolutiony",
+ "type": "long"
+ },
+ {
+ "description": "Model Name of vGPU",
+ "name": "vgputype",
+ "type": "string"
+ },
+ {
"description": "Maximum vgpu can be created with this vgpu type on the given gpu group",
"name": "maxcapacity",
"type": "long"
},
{
- "description": "Maximum displays per user",
- "name": "maxheads",
- "type": "long"
- },
- {
- "description": "Maximum no. of vgpu per gpu card (pgpu)",
- "name": "maxvgpuperpgpu",
- "type": "long"
- },
- {
"description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type",
"name": "remainingcapacity",
"type": "long"
},
{
- "description": "Maximum Y resolution per display",
- "name": "maxresolutiony",
+ "description": "Maximum no. of vgpu per gpu card (pgpu)",
+ "name": "maxvgpuperpgpu",
"type": "long"
},
{
@@ -35966,88 +36456,39 @@
"type": "list"
},
{
- "description": "the total disk size of the host",
- "name": "disksizetotal",
- "type": "long"
+ "description": "the cpu average load on the host",
+ "name": "cpuloadaverage",
+ "type": "double"
},
{
- "description": "the Zone ID of the host",
- "name": "zoneid",
+ "description": "the amount of the host's CPU currently allocated",
+ "name": "cpuallocated",
"type": "string"
},
+ {},
{
- "description": "the amount of the host's memory currently allocated in percentage",
- "name": "memoryallocatedpercentage",
- "type": "string"
- },
- {
- "description": "the Zone name of the host",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning",
- "name": "memorytotal",
- "type": "long"
- },
- {
- "description": "true if local storage is active, false otherwise",
- "name": "islocalstorageactive",
- "type": "boolean"
- },
- {
- "description": "the hypervisor version",
- "name": "hypervisorversion",
- "type": "string"
- },
- {
- "description": "the ID of the host",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the amount of the host's CPU currently allocated in percentage",
- "name": "cpuallocatedpercentage",
- "type": "string"
- },
- {
- "description": "the amount of the host's memory currently allocated",
- "name": "memoryallocated",
- "type": "long"
- },
- {
- "description": "Host details in key/value pairs.",
- "name": "details",
- "type": "map"
- },
- {
- "description": "events available for the host",
- "name": "events",
- "type": "string"
- },
- {
- "description": "true if the host has capability to support UEFI boot",
- "name": "ueficapability",
- "type": "boolean"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
+ "description": "the CPU number of the host",
+ "name": "cpunumber",
"type": "integer"
},
{
- "description": "the last time this host was annotated",
- "name": "lastannotated",
- "type": "date"
+ "description": "the amount of the host's memory currently allocated in bytes",
+ "name": "memoryallocatedbytes",
+ "type": "long"
},
{
- "description": "the cluster name of the host",
- "name": "clustername",
+ "description": "the Pod name of the host",
+ "name": "podname",
"type": "string"
},
{
- "description": "the amount of the host's memory currently used",
- "name": "memoryused",
+ "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"
},
{
@@ -36056,24 +36497,64 @@
"type": "string"
},
{
- "description": "the Pod name of the host",
- "name": "podname",
+ "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise",
+ "name": "suitableformigration",
+ "type": "boolean"
+ },
+ {
+ "description": "the amount of the host's memory currently allocated",
+ "name": "memoryallocated",
+ "type": "long"
+ },
+ {
+ "description": "the host version",
+ "name": "version",
"type": "string"
},
{
+ "description": "Host details in key/value pairs.",
+ "name": "details",
+ "type": "map"
+ },
+ {
+ "description": "the last annotation set on this host by an admin",
+ "name": "annotation",
+ "type": "string"
+ },
+ {
+ "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise",
+ "name": "hahost",
+ "type": "boolean"
+ },
+ {
+ "description": "the number of CPU sockets on the host",
+ "name": "cpusockets",
+ "type": "integer"
+ },
+ {
+ "description": "the date and time the host was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the name of the host",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the host's CPU currently allocated in MHz",
+ "name": "cpuallocatedvalue",
+ "type": "long"
+ },
+ {
"description": "the cluster type of the cluster that host belongs to",
"name": "clustertype",
"type": "string"
},
{
- "description": "the cluster ID of the host",
- "name": "clusterid",
- "type": "string"
- },
- {
- "description": "the amount of the host's CPU currently used",
- "name": "cpuused",
- "type": "string"
+ "description": "the incoming network traffic on the host",
+ "name": "networkkbsread",
+ "type": "long"
},
{
"description": "the CPU speed of the host",
@@ -36081,25 +36562,89 @@
"type": "long"
},
{
- "description": "the admin that annotated this host",
- "name": "username",
+ "description": "the OS category name of the host",
+ "name": "oscategoryname",
"type": "string"
},
{
+ "description": "the IP address of the host",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "the 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 memory total of the host, this parameter is deprecated use memorywithoverprovisioning",
+ "name": "memorytotal",
+ "type": "long"
+ },
+ {
+ "description": "the cluster ID of the host",
+ "name": "clusterid",
+ "type": "string"
+ },
+ {
+ "description": "the last time this host was annotated",
+ "name": "lastannotated",
+ "type": "date"
+ },
+ {
+ "description": "true if the host has capability to support UEFI boot",
+ "name": "ueficapability",
+ "type": "boolean"
+ },
+ {
+ "description": "the OS category ID of the host",
+ "name": "oscategoryid",
+ "type": "string"
+ },
+ {
+ "description": "the cluster name of the host",
+ "name": "clustername",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise",
+ "name": "hasenoughcapacity",
+ "type": "boolean"
+ },
+ {
+ "description": "the outgoing network traffic on the host",
+ "name": "networkkbswrite",
+ "type": "long"
+ },
+ {
+ "description": "capabilities of the host",
+ "name": "capabilities",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the host's memory currently used",
+ "name": "memoryused",
+ "type": "long"
+ },
+ {
"description": "the state of the host",
"name": "state",
"type": "status"
},
- {},
{
- "description": "the amount of the host's memory after applying the mem.overprovisioning.factor",
- "name": "memorywithoverprovisioning",
- "type": "string"
- },
- {
- "description": "the host hypervisor",
- "name": "hypervisor",
- "type": "hypervisortype"
+ "description": "the date and time the host was removed",
+ "name": "removed",
+ "type": "date"
}
]
},
@@ -36128,6 +36673,11 @@
"related": "addOpenDaylightController,deleteOpenDaylightController",
"response": [
{
+ "description": "the url of the controller api",
+ "name": "url",
+ "type": "string"
+ },
+ {
"description": "the name assigned to the controller",
"name": "name",
"type": "string"
@@ -36137,10 +36687,9 @@
"name": "physicalnetworkid",
"type": "string"
},
- {},
{
- "description": "the url of the controller api",
- "name": "url",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
@@ -36148,22 +36697,18 @@
"name": "id",
"type": "string"
},
+ {},
{
"description": "the username to authenticate to the controller",
"name": "username",
"type": "string"
},
+ {},
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {}
+ }
]
},
{
@@ -36172,6 +36717,20 @@
"name": "addBigSwitchBcfDevice",
"params": [
{
+ "description": "Password of the BigSwitch BCF Controller.",
+ "length": 255,
+ "name": "password",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "Username of the BigSwitch BCF Controller.",
+ "length": 255,
+ "name": "username",
+ "required": true,
+ "type": "string"
+ },
+ {
"description": "the Physical Network ID",
"length": 255,
"name": "physicalnetworkid",
@@ -36192,57 +36751,32 @@
"name": "hostname",
"required": true,
"type": "string"
- },
- {
- "description": "Username of the BigSwitch BCF Controller.",
- "length": 255,
- "name": "username",
- "required": true,
- "type": "string"
- },
- {
- "description": "Password of the BigSwitch BCF Controller.",
- "length": 255,
- "name": "password",
- "required": true,
- "type": "string"
}
],
"related": "listBigSwitchBcfDevices",
"response": [
{
- "description": "the controller username",
- "name": "username",
- "type": "string"
- },
- {
- "description": "the controller Ip address",
- "name": "hostname",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
"description": "name of the provider",
"name": "provider",
"type": "string"
},
{},
- {},
{
"description": "device name",
"name": "bigswitchdevicename",
"type": "string"
},
{
+ "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 controller password",
"name": "password",
"type": "string"
@@ -36253,13 +36787,24 @@
"type": "boolean"
},
{
+ "description": "device id of the BigSwitch BCF Controller",
+ "name": "bcfdeviceid",
+ "type": "string"
+ },
+ {},
+ {
"description": "the physical network to which this BigSwitch BCF segment belongs to",
"name": "physicalnetworkid",
"type": "string"
},
{
- "description": "device id of the BigSwitch BCF Controller",
- "name": "bcfdeviceid",
+ "description": "the controller Ip address",
+ "name": "hostname",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
}
],
@@ -36280,27 +36825,27 @@
}
],
"response": [
- {},
- {
- "description": "true if operation is executed successfully",
- "name": "success",
- "type": "boolean"
- },
{
"description": "any text associated with the success or failure",
"name": "displaytext",
"type": "string"
},
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
{},
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
+ },
+ {
+ "description": "true if operation is executed successfully",
+ "name": "success",
+ "type": "boolean"
+ },
+ {},
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
}
]
},
@@ -36310,28 +36855,28 @@
"name": "updateDefaultNicForVirtualMachine",
"params": [
{
- "description": "NIC ID",
- "length": 255,
- "name": "nicid",
- "related": "",
- "required": true,
- "type": "uuid"
- },
- {
"description": "Virtual Machine ID",
"length": 255,
"name": "virtualmachineid",
"related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance",
"required": true,
"type": "uuid"
+ },
+ {
+ "description": "NIC ID",
+ "length": 255,
+ "name": "nicid",
+ "related": "",
+ "required": true,
+ "type": "uuid"
}
],
"related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance",
"response": [
{
- "description": "the state of the virtual machine",
- "name": "state",
- "type": "string"
+ "description": "Vm details in key/value pairs.",
+ "name": "details",
+ "type": "map"
},
{
"description": "the ID of the host for the virtual machine",
@@ -36339,14 +36884,9 @@
"type": "string"
},
{
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
- },
- {
- "description": "Guest vm Boot Type",
- "name": "boottype",
- "type": "string"
+ "description": "the read (io) of disk on the vm",
+ "name": "diskioread",
+ "type": "long"
},
{
"description": "the name of the template for the virtual machine",
@@ -36354,21 +36894,52 @@
"type": "string"
},
{
- "description": "the name of the service offering of the virtual machine",
- "name": "serviceofferingname",
+ "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",
+ "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": "true if high-availability is enabled, false otherwise",
+ "name": "haenable",
+ "type": "boolean"
+ },
+ {
+ "description": "the date when this virtual machine was updated last time",
+ "name": "lastupdated",
"type": "date"
},
{
- "description": "Guest vm Boot Mode",
- "name": "bootmode",
+ "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": "the user's ID who deployed the virtual machine",
+ "name": "userid",
+ "type": "string"
+ },
+ {
+ "description": "the speed of each cpu",
+ "name": "cpuspeed",
+ "type": "integer"
+ },
+ {
"description": "the list of nics associated with vm",
"name": "nic",
"response": [
@@ -36378,13 +36949,48 @@
"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 name of the corresponding network",
+ "name": "networkname",
+ "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 ID of the nic",
- "name": "id",
+ "description": "true if nic is default, false otherwise",
+ "name": "macaddress",
+ "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 cidr of IPv6 network",
+ "name": "ip6cidr",
"type": "string"
},
{
@@ -36393,13 +36999,23 @@
"type": "list"
},
{
- "description": "the netmask of the nic",
- "name": "netmask",
+ "description": "the gateway of the nic",
+ "name": "gateway",
"type": "string"
},
{
- "description": "true if nic is default, false otherwise",
- "name": "macaddress",
+ "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise",
+ "name": "nsxlogicalswitchport",
+ "type": "string"
+ },
+ {
+ "description": "IP addresses associated with NIC found for unmanaged VM",
+ "name": "ipaddresses",
+ "type": "list"
+ },
+ {
+ "description": "the type of the nic",
+ "name": "type",
"type": "string"
},
{
@@ -36413,38 +37029,13 @@
"type": "string"
},
{
- "description": "the name of the corresponding network",
- "name": "networkname",
+ "description": "device id for the network when plugged into the virtual machine",
+ "name": "deviceid",
"type": "string"
},
{
- "description": "the 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": "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": "Type of adapter if available",
- "name": "adaptertype",
+ "description": "the ID of the nic",
+ "name": "id",
"type": "string"
},
{
@@ -36453,43 +37044,8 @@
"type": "integer"
},
{
- "description": "ID of the VLAN/VNI if available",
- "name": "vlanid",
- "type": "integer"
- },
- {
- "description": "the traffic type of the nic",
- "name": "traffictype",
- "type": "string"
- },
- {
- "description": "the isolated private VLAN type if available",
- "name": "isolatedpvlantype",
- "type": "string"
- },
- {
- "description": "the ip address of the nic",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "description": "IP addresses associated with NIC found for unmanaged VM",
- "name": "ipaddresses",
- "type": "list"
- },
- {
- "description": "device id for the network when plugged into the virtual machine",
- "name": "deviceid",
- "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",
+ "description": "the netmask of the nic",
+ "name": "netmask",
"type": "string"
},
{
@@ -36498,128 +37054,81 @@
"type": "list"
},
{
- "description": "the gateway of the nic",
- "name": "gateway",
+ "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 traffic type of the nic",
+ "name": "traffictype",
+ "type": "string"
+ },
+ {
+ "description": "ID of the VLAN/VNI if available",
+ "name": "vlanid",
+ "type": "integer"
}
],
"type": "set"
},
{
- "description": "Os type ID of the virtual machine",
- "name": "guestosid",
+ "description": "an alternate display text of the ISO attached to the virtual machine",
+ "name": "isodisplaytext",
"type": "string"
},
{
- "description": "the ID of the disk offering of the virtual machine",
- "name": "diskofferingid",
+ "description": "the ID of the backup offering of the virtual machine",
+ "name": "backupofferingid",
"type": "string"
},
{
- "description": "the outgoing network traffic on the host",
- "name": "networkkbswrite",
+ "description": "device ID of the root volume",
+ "name": "rootdeviceid",
"type": "long"
},
{
- "description": "the name of the disk offering of the virtual machine",
- "name": "diskofferingname",
- "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": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.",
- "name": "isdynamicallyscalable",
- "type": "boolean"
- },
- {
- "description": "the read (io) of disk on the vm",
- "name": "diskioread",
+ "description": "the internal memory that's free in vm or zero if it can not be calculated",
+ "name": "memoryintfreekbs",
"type": "long"
},
{
- "description": "the vgpu type used by the virtual machine",
- "name": "vgpu",
- "type": "string"
- },
- {
"description": "the password (if exists) of the virtual machine",
"name": "password",
"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": "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",
- "type": "string"
- },
- {
- "description": "OS name of the vm",
- "name": "osdisplayname",
- "type": "string"
- },
- {
- "description": "the group name of the virtual machine",
- "name": "group",
- "type": "string"
- },
- {
"description": "the ID of the availablility 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 account associated with the virtual machine",
+ "name": "account",
"type": "string"
},
{
- "description": "the name of the ISO attached to the virtual machine",
- "name": "isoname",
+ "description": "instance name of the user vm; this parameter is returned to the ROOT admin only",
+ "name": "instancename",
"type": "string"
},
{
- "description": "the speed of each cpu",
- "name": "cpuspeed",
- "type": "integer"
- },
- {
- "description": "ssh key-pair",
- "name": "keypair",
+ "description": "the hypervisor on which the template runs",
+ "name": "hypervisor",
"type": "string"
},
{
- "description": "the ID of the domain in which the virtual machine exists",
- "name": "domainid",
- "type": "string"
+ "description": "the write (bytes) of disk on the vm",
+ "name": "diskkbswrite",
+ "type": "long"
},
- {},
{
- "description": "the project id of the vm",
- "name": "projectid",
+ "description": "Os type ID of the virtual machine",
+ "name": "guestosid",
"type": "string"
},
{
@@ -36627,266 +37136,13 @@
"name": "securitygroup",
"response": [
{
- "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 ID of the security group",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the list of ingress rules associated with the security group",
- "name": "ingressrule",
- "response": [
- {
- "description": "the type of the ICMP message response",
- "name": "icmptype",
- "type": "integer"
- },
- {
- "description": "the code for the ICMP message response",
- "name": "icmpcode",
- "type": "integer"
- },
- {
- "description": "the starting IP of the security group rule",
- "name": "startport",
- "type": "integer"
- },
- {
- "description": "the CIDR notation for the base IP address of the security group rule",
- "name": "cidr",
- "type": "string"
- },
- {
- "description": "account owning the security group rule",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the protocol of the security group rule",
- "name": "protocol",
- "type": "string"
- },
- {
- "description": "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": "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 domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the id of the security group rule",
- "name": "ruleid",
- "type": "string"
- },
- {
- "description": "the ending IP of the security group rule ",
- "name": "endport",
- "type": "integer"
- },
- {
- "description": "security group name",
- "name": "securitygroupname",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the account owning the security group",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the ID of the security group",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the project name of the group",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the 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",
- "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": "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 list of resource tags associated with the rule",
- "name": "tags",
- "response": [
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- }
- ],
- "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"
- }
- ],
- "type": "set"
- },
- {
"description": "the number of virtualmachines associated with this securitygroup",
"name": "virtualmachinecount",
"type": "integer"
},
{
- "description": "the list of virtualmachine ids associated with this securitygroup",
- "name": "virtualmachineids",
- "type": "set"
- },
- {
- "description": "the domain name of the security group",
- "name": "domain",
+ "description": "the project name of the group",
+ "name": "project",
"type": "string"
},
{
@@ -36899,33 +37155,8 @@
"type": "string"
},
{
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the project 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",
+ "description": "customer associated with the tag",
+ "name": "customer",
"type": "string"
},
{
@@ -36934,69 +37165,404 @@
"type": "string"
},
{
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
"description": "resource type",
"name": "resourcetype",
"type": "string"
},
{
- "description": "customer associated with the tag",
- "name": "customer",
+ "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 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 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",
+ "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": "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": "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": "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": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ }
+ ],
+ "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 ID of the security group",
+ "name": "id",
+ "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 account owning the security group",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the domain name of the security group",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the list of 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 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",
+ "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": "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": "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 ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the id of the security group rule",
+ "name": "ruleid",
+ "type": "string"
+ },
+ {
+ "description": "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 list of virtualmachine ids associated with this securitygroup",
+ "name": "virtualmachineids",
+ "type": "set"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the virtual network for the service offering",
+ "name": "forvirtualnetwork",
+ "type": "boolean"
+ },
+ {
+ "description": "the name of the disk offering of the virtual machine",
+ "name": "diskofferingname",
+ "type": "string"
+ },
+ {
+ "description": "the user's name who deployed the virtual machine",
+ "name": "username",
+ "type": "string"
+ },
+ {
+ "description": "the name of the ISO attached to the virtual machine",
+ "name": "isoname",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the vm",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the memory allocated for the virtual machine",
+ "name": "memory",
+ "type": "integer"
+ },
+ {
+ "description": "OS type id of the vm",
+ "name": "ostypeid",
+ "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": "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 ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
}
],
"type": "set"
},
{
- "description": "true if the password rest feature is enabled, false otherwise",
- "name": "passwordenabled",
- "type": "boolean"
- },
- {
- "description": "the account associated with the virtual machine",
- "name": "account",
+ "description": "Guest vm Boot Type",
+ "name": "boottype",
"type": "string"
},
{
- "description": "the number of cpu this virtual machine is running with",
- "name": "cpunumber",
- "type": "integer"
- },
- {
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "the incoming network traffic on the vm",
- "name": "networkkbsread",
- "type": "long"
- },
- {
- "description": "the name of the availability zone for the virtual machine",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "the memory used by the vm",
- "name": "memorykbs",
- "type": "long"
- },
- {
- "description": "the name of the virtual machine",
- "name": "name",
- "type": "string"
- },
- {
- "description": " an alternate display text of the template for the virtual machine",
- "name": "templatedisplaytext",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
@@ -37005,33 +37571,13 @@
"type": "string"
},
{
- "description": "the amount of the vm's CPU currently used",
- "name": "cpuused",
- "type": "string"
+ "description": "the total number of network traffic bytes received",
+ "name": "receivedbytes",
+ "type": "long"
},
{
- "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.",
- "name": "templateid",
- "type": "string"
- },
- {
- "description": "Vm details in key/value pairs.",
- "name": "details",
- "type": "map"
- },
- {
- "description": "true if high-availability is enabled, false otherwise",
- "name": "haenable",
- "type": "boolean"
- },
- {
- "description": "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",
+ "description": "the vgpu type used by the virtual machine",
+ "name": "vgpu",
"type": "string"
},
{
@@ -37040,13 +37586,18 @@
"type": "long"
},
{
- "description": "an alternate display text of the ISO attached to the virtual machine",
- "name": "isodisplaytext",
+ "description": "the ID of the service offering of the virtual machine",
+ "name": "serviceofferingid",
"type": "string"
},
{
- "description": "device type of the root volume",
- "name": "rootdevicetype",
+ "description": "the name of the service offering of the virtual machine",
+ "name": "serviceofferingname",
+ "type": "string"
+ },
+ {
+ "description": "the 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"
},
{
@@ -37054,11 +37605,6 @@
"name": "affinitygroup",
"response": [
{
- "description": "the domain name of the affinity group",
- "name": "domain",
- "type": "string"
- },
- {
"description": "the account owning the affinity group",
"name": "account",
"type": "string"
@@ -37069,16 +37615,6 @@
"type": "string"
},
{
- "description": "the description of the affinity group",
- "name": "description",
- "type": "string"
- },
- {
- "description": "virtual machine IDs associated with this affinity group",
- "name": "virtualmachineIds",
- "type": "list"
- },
- {
"description": "the project name of the affinity group",
"name": "project",
"type": "string"
@@ -37089,8 +37625,18 @@
"type": "string"
},
{
- "description": "the name of the affinity group",
- "name": "name",
+ "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"
},
{
@@ -37099,27 +37645,37 @@
"type": "string"
},
{
- "description": "the domain ID of the affinity group",
- "name": "domainid",
+ "description": "the description of the affinity group",
+ "name": "description",
+ "type": "string"
+ },
+ {
+ "description": "the name of the affinity group",
+ "name": "name",
"type": "string"
}
],
"type": "set"
},
{
+ "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"
},
{
- "description": "the write (bytes) of disk on the vm",
- "name": "diskkbswrite",
- "type": "long"
+ "description": "List of read-only Vm details as comma separated string.",
+ "name": "readonlydetails",
+ "type": "string"
},
{
- "description": "the date when this virtual machine was updated last time",
- "name": "lastupdated",
- "type": "date"
+ "description": "the name of the virtual machine",
+ "name": "name",
+ "type": "string"
},
{
"description": "the target memory in vm",
@@ -37127,24 +37683,14 @@
"type": "long"
},
{
- "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 total number of network traffic bytes received",
- "name": "receivedbytes",
- "type": "long"
- },
- {
- "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 date when this virtual machine was created",
+ "name": "created",
+ "type": "date"
},
{
"description": "the current status of the latest async job acting on this object",
@@ -37152,97 +37698,36 @@
"type": "integer"
},
{
- "description": "the ID of the ISO attached to the virtual machine",
- "name": "isoid",
+ "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": "device type of the root volume",
+ "name": "rootdevicetype",
"type": "string"
},
{
- "description": "the hypervisor on which the template runs",
- "name": "hypervisor",
- "type": "string"
- },
- {
- "description": "the total number of network traffic bytes sent",
- "name": "sentbytes",
- "type": "long"
- },
- {
- "description": "the project name of the vm",
- "name": "project",
- "type": "string"
- },
- {
- "description": "device ID of the root volume",
- "name": "rootdeviceid",
- "type": "long"
+ "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.",
+ "name": "isdynamicallyscalable",
+ "type": "boolean"
},
{},
{
- "description": "OS type id of the vm",
- "name": "ostypeid",
+ "description": " an alternate display text of the template for the virtual machine",
+ "name": "templatedisplaytext",
"type": "string"
},
+ {},
{
- "description": "the list of resource tags associated",
- "name": "tags",
- "response": [
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "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": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- }
- ],
- "type": "set"
+ "description": "the incoming network traffic on the vm",
+ "name": "networkkbsread",
+ "type": "long"
+ },
+ {
+ "description": "Guest vm Boot Mode",
+ "name": "bootmode",
+ "type": "string"
},
{
"description": "the pool type of the virtual machine",
@@ -37250,34 +37735,94 @@
"type": "string"
},
{
- "description": "the user's name who deployed the virtual machine",
- "name": "username",
+ "description": "the ID of the virtual machine",
+ "name": "id",
"type": "string"
},
{
- "description": "the ID of the backup offering of the virtual machine",
- "name": "backupofferingid",
- "type": "string"
- },
- {
- "description": "the virtual network for the service offering",
- "name": "forvirtualnetwork",
- "type": "boolean"
- },
- {
- "description": "the ID of the service offering of the virtual machine",
- "name": "serviceofferingid",
- "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 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 ID of the ISO attached to the virtual machine",
+ "name": "isoid",
+ "type": "string"
+ },
+ {
+ "description": "the outgoing network traffic on the host",
+ "name": "networkkbswrite",
+ "type": "long"
+ },
+ {
+ "description": "the ID of the disk offering of the virtual machine",
+ "name": "diskofferingid",
+ "type": "string"
+ },
+ {
+ "description": "the number of cpu this virtual machine is running with",
+ "name": "cpunumber",
+ "type": "integer"
+ },
+ {
+ "description": "the name of the domain in which the virtual machine exists",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the memory used by the vm",
+ "name": "memorykbs",
+ "type": "long"
+ },
+ {
+ "description": "the ID of the domain in which the virtual machine exists",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the project id of the vm",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "public IP address id associated with vm via Static nat rule",
+ "name": "publicip",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the vm's CPU currently used",
+ "name": "cpuused",
+ "type": "string"
+ },
+ {
+ "description": "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 group name of the virtual machine",
+ "name": "group",
+ "type": "string"
+ },
+ {
+ "description": "ssh key-pair",
+ "name": "keypair",
+ "type": "string"
+ },
+ {
+ "description": "the state of the virtual machine",
+ "name": "state",
+ "type": "string"
}
]
},
@@ -37296,28 +37841,28 @@
}
],
"response": [
- {},
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
{
- "description": "any text associated with the success or failure",
- "name": "displaytext",
- "type": "string"
- },
- {
- "description": "true if operation is executed successfully",
- "name": "success",
- "type": "boolean"
- },
- {
"description": "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"
+ }
]
},
{
@@ -37326,13 +37871,6 @@
"name": "issueOutOfBandManagementPowerAction",
"params": [
{
- "description": "out-of-band management power actions, valid actions are: ON, OFF, CYCLE, RESET, SOFT, STATUS",
- "length": 255,
- "name": "action",
- "required": true,
- "type": "string"
- },
- {
"description": "optional operation timeout in seconds that overrides the global or cluster-level out-of-band management timeout setting",
"length": 255,
"name": "timeout",
@@ -37346,10 +37884,48 @@
"related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost",
"required": true,
"type": "uuid"
+ },
+ {
+ "description": "out-of-band management power actions, valid actions are: ON, OFF, CYCLE, RESET, SOFT, STATUS",
+ "length": 255,
+ "name": "action",
+ "required": true,
+ "type": "string"
}
],
"related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster",
"response": [
+ {},
+ {
+ "description": "the out-of-band management interface username",
+ "name": "username",
+ "type": "string"
+ },
+ {
+ "description": "the operation result",
+ "name": "status",
+ "type": "boolean"
+ },
+ {
+ "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 current status of the latest async job acting 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 out-of-band management action (if issued)",
"name": "action",
@@ -37366,13 +37942,8 @@
"type": "string"
},
{
- "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",
+ "description": "the operation result description",
+ "name": "description",
"type": "string"
},
{
@@ -37381,42 +37952,16 @@
"type": "string"
},
{
- "description": "the operation result",
- "name": "status",
- "type": "boolean"
- },
- {
- "description": "the operation result description",
- "name": "description",
- "type": "string"
- },
- {
- "description": "the out-of-band management driver for the host",
- "name": "driver",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
"description": "the out-of-band management interface address",
"name": "address",
"type": "string"
},
{
- "description": "true if out-of-band management is enabled for the host",
- "name": "enabled",
- "type": "boolean"
- },
- {},
- {},
- {
"description": "the out-of-band management interface powerState of the host",
"name": "powerstate",
"type": "powerstate"
- }
+ },
+ {}
],
"since": "4.9.0"
},
@@ -37426,6 +37971,20 @@
"name": "issueCertificate",
"params": [
{
+ "description": "The certificate signing request (in pem format), if CSR is not provided then configured/provided options are considered",
+ "length": 65535,
+ "name": "csr",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "Comma separated list of IP addresses, the certificate should be issued for",
+ "length": 255,
+ "name": "ipaddress",
+ "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",
@@ -37440,29 +37999,21 @@
"type": "string"
},
{
- "description": "The certificate signing request (in pem format), if CSR is not provided then configured/provided options are considered",
- "length": 65535,
- "name": "csr",
- "required": false,
- "type": "string"
- },
- {
"description": "Certificate validity duration in number of days, when not provided the default configured value will be used",
"length": 255,
"name": "duration",
"required": false,
"type": "integer"
- },
- {
- "description": "Comma separated list of IP addresses, the certificate should be issued for",
- "length": 255,
- "name": "ipaddress",
- "required": false,
- "type": "string"
}
],
"related": "listCaCertificate",
"response": [
+ {},
+ {
+ "description": "The client certificate",
+ "name": "certificate",
+ "type": "string"
+ },
{
"description": "Private key for the certificate",
"name": "privatekey",
@@ -37474,21 +38025,15 @@
"type": "string"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "The client certificate",
- "name": "certificate",
- "type": "string"
- },
- {
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
- {},
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
{}
],
"since": "4.11.0"
@@ -37515,9 +38060,9 @@
"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"
},
{},
{
@@ -37526,9 +38071,9 @@
"type": "string"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
+ "description": "true if operation is executed successfully",
+ "name": "success",
+ "type": "boolean"
}
]
},
@@ -37538,70 +38083,29 @@
"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": true,
+ "type": "boolean"
+ },
+ {
"description": "Image Store UUID",
"length": 255,
"name": "id",
"related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore",
"required": true,
"type": "uuid"
- },
- {
- "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": true,
- "type": "boolean"
}
],
"related": "addSecondaryStorage,listSwifts,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore",
"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 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": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
"description": "the host's currently used disk size",
"name": "disksizeused",
"type": "long"
},
{
- "description": "the scope of the image store",
- "name": "scope",
- "type": "scopetype"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the ID of the image store",
- "name": "id",
- "type": "string"
- },
- {
"description": "the Zone ID of the image store",
"name": "zoneid",
"type": "string"
@@ -37611,21 +38115,62 @@
"name": "readonly",
"type": "boolean"
},
- {},
+ {
+ "description": "the scope of the image store",
+ "name": "scope",
+ "type": "scopetype"
+ },
{
"description": "the provider name of the image store",
"name": "providername",
"type": "string"
},
{
+ "description": "the Zone name of the image store",
+ "name": "zonename",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
"description": "the protocol of the image store",
"name": "protocol",
"type": "string"
},
{
+ "description": "the 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 total disk size of the host",
+ "name": "disksizetotal",
+ "type": "long"
+ },
+ {
+ "description": "the name of the image store",
+ "name": "name",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the ID of the image store",
+ "name": "id",
+ "type": "string"
}
],
"since": "4.15.0"
@@ -37636,33 +38181,12 @@
"name": "createPortForwardingRule",
"params": [
{
- "description": "the starting port of port forwarding rule's public port range",
+ "description": "the IP address id of the port forwarding rule",
"length": 255,
- "name": "publicport",
+ "name": "ipaddressid",
+ "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses",
"required": true,
- "type": "integer"
- },
- {
- "description": "an optional field, whether to the display the rule to the end user or not",
- "length": 255,
- "name": "fordisplay",
- "required": false,
- "since": "4.4",
- "type": "boolean"
- },
- {
- "description": "the 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.",
- "length": 255,
- "name": "protocol",
- "required": true,
- "type": "string"
+ "type": "uuid"
},
{
"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).",
@@ -37673,6 +38197,42 @@
"type": "uuid"
},
{
+ "description": "the cidr list to forward traffic from. Multiple entries must be separated by a single comma character (,). This parameter is deprecated. Do not use.",
+ "length": 255,
+ "name": "cidrlist",
+ "required": false,
+ "type": "list"
+ },
+ {
+ "description": "the ID of the virtual machine for the port forwarding rule",
+ "length": 255,
+ "name": "virtualmachineid",
+ "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance",
+ "required": true,
+ "type": "uuid"
+ },
+ {
+ "description": "the starting port of port forwarding rule's public port range",
+ "length": 255,
+ "name": "publicport",
+ "required": true,
+ "type": "integer"
+ },
+ {
+ "description": "the protocol for the port forwarding rule. Valid values are TCP or UDP.",
+ "length": 255,
+ "name": "protocol",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "the ending port of port forwarding rule's private port range",
+ "length": 255,
+ "name": "publicendport",
+ "required": false,
+ "type": "integer"
+ },
+ {
"description": "the starting port of port forwarding rule's private port range",
"length": 255,
"name": "privateport",
@@ -37680,14 +38240,6 @@
"type": "integer"
},
{
- "description": "the IP address id of the port forwarding rule",
- "length": 255,
- "name": "ipaddressid",
- "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses",
- "required": true,
- "type": "uuid"
- },
- {
"description": "VM guest nic secondary IP address for the port forwarding rule",
"length": 255,
"name": "vmguestip",
@@ -37695,11 +38247,11 @@
"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.",
+ "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": "cidrlist",
+ "name": "openfirewall",
"required": false,
- "type": "list"
+ "type": "boolean"
},
{
"description": "the ending port of port forwarding rule's private port range",
@@ -37709,50 +38261,32 @@
"type": "integer"
},
{
- "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. If not specified 1) defaulted to false when PF rule is being created for VPC guest network 2) in all other cases defaulted to true",
+ "description": "an optional field, whether to the display the rule to the end user or not",
"length": 255,
- "name": "openfirewall",
+ "name": "fordisplay",
"required": false,
+ "since": "4.4",
"type": "boolean"
- },
- {
- "description": "the ID of the virtual machine for the port forwarding rule",
- "length": 255,
- "name": "virtualmachineid",
- "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance",
- "required": true,
- "type": "uuid"
}
],
"related": "listPortForwardingRules,updatePortForwardingRule",
"response": [
{
- "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).",
- "name": "cidrlist",
+ "description": "the VM display name for the port forwarding rule",
+ "name": "virtualmachinedisplayname",
+ "type": "string"
+ },
+ {
+ "description": "the 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 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": "is firewall for display to the regular user",
"name": "fordisplay",
@@ -37763,54 +38297,65 @@
"name": "jobstatus",
"type": "integer"
},
- {
- "description": "the starting port of port forwarding rule's private port range",
- "name": "privateport",
- "type": "string"
- },
- {
- "description": "the ID of the port forwarding rule",
- "name": "id",
- "type": "string"
- },
+ {},
{
"description": "the id of the guest network the port forwarding rule belongs to",
"name": "networkid",
"type": "string"
},
{
- "description": "the VM name for the port forwarding rule",
- "name": "virtualmachinename",
- "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 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 public ip address for the port forwarding rule",
"name": "ipaddress",
"type": "string"
},
{
- "description": "the state of the rule",
- "name": "state",
+ "description": "the ending port of port forwarding rule's private port range",
+ "name": "publicendport",
+ "type": "string"
+ },
+ {
+ "description": "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 ID for the port forwarding rule",
+ "name": "virtualmachineid",
+ "type": "string"
+ },
+ {
+ "description": "the VM name for the port forwarding rule",
+ "name": "virtualmachinename",
+ "type": "string"
+ },
+ {
+ "description": "the starting port of port forwarding rule's private port range",
+ "name": "privateport",
+ "type": "string"
+ },
+ {
+ "description": "the 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 vm ip address for the port forwarding rule",
+ "name": "vmguestip",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the port forwarding rule",
+ "name": "id",
"type": "string"
},
{
@@ -37818,8 +38363,8 @@
"name": "tags",
"response": [
{
- "description": "id of the resource",
- "name": "resourceid",
+ "description": "resource type",
+ "name": "resourcetype",
"type": "string"
},
{
@@ -37833,6 +38378,16 @@
"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"
@@ -37843,36 +38398,26 @@
"type": "string"
},
{
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
"description": "customer associated with the tag",
"name": "customer",
"type": "string"
},
{
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
+ "description": "id of the resource",
+ "name": "resourceid",
"type": "string"
}
],
"type": "list"
},
{
- "description": "the public ip address id for the port forwarding rule",
- "name": "ipaddressid",
+ "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).",
+ "name": "cidrlist",
"type": "string"
}
]
@@ -37883,14 +38428,6 @@
"name": "prepareTemplate",
"params": [
{
- "description": "template ID of the template to be prepared in primary storage(s).",
- "length": 255,
- "name": "templateid",
- "related": "prepareTemplate,listIsos,registerIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos",
- "required": true,
- "type": "uuid"
- },
- {
"description": "zone ID of the template to be prepared in primary storage(s).",
"length": 255,
"name": "zoneid",
@@ -37905,11 +38442,60 @@
"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,
+ "name": "templateid",
+ "related": "prepareTemplate,listIsos,registerIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos",
+ "required": true,
+ "type": "uuid"
}
],
"related": "listIsos,registerIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos",
"response": [
{
+ "description": "the name of the OS type for this template.",
+ "name": "ostypename",
+ "type": "string"
+ },
+ {
+ "description": "the date this template was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "if root disk template, then ids of the datas disk templates this template owns",
+ "name": "childtemplates",
+ "type": "set"
+ },
+ {
+ "description": "the name of the secondary storage host for the template",
+ "name": "hostname",
+ "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",
+ "type": "map"
+ },
+ {
+ "description": "the date this template was removed",
+ "name": "removed",
+ "type": "date"
+ },
+ {
+ "description": "true if this template is a featured template, false otherwise",
+ "name": "isfeatured",
+ "type": "boolean"
+ },
+ {
"description": "the account id to which the template belongs",
"name": "accountid",
"type": "string"
@@ -37920,14 +38506,94 @@
"type": "string"
},
{
+ "description": "the template ID of the parent template if present",
+ "name": "sourcetemplateid",
+ "type": "string"
+ },
+ {
+ "description": "the hypervisor on which the template runs",
+ "name": "hypervisor",
+ "type": "string"
+ },
+ {
+ "description": "the physical size of the template",
+ "name": "physicalsize",
+ "type": "long"
+ },
+ {
+ "description": "true if this template is a public template, false otherwise",
+ "name": "ispublic",
+ "type": "boolean"
+ },
+ {
+ "description": "true if the template is extractable, false otherwise",
+ "name": "isextractable",
+ "type": "boolean"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
"description": "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": "additional key/value details tied with template",
+ "name": "details",
+ "type": "map"
+ },
+ {
+ "description": "the tag of this template",
+ "name": "templatetag",
+ "type": "string"
+ },
+ {
+ "description": "true if the reset password feature is enabled, false otherwise",
+ "name": "passwordenabled",
+ "type": "boolean"
+ },
+ {
+ "description": "the ID of the domain to which the template belongs",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.",
+ "name": "deployasis",
+ "type": "boolean"
+ },
+ {
+ "description": "the project id of the template",
+ "name": "projectid",
+ "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 the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the account name to which the template belongs",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the OS type for this template.",
+ "name": "ostypeid",
+ "type": "string"
},
{
"description": "the template ID",
@@ -37935,9 +38601,24 @@
"type": "string"
},
{
- "description": "the date this template was created",
- "name": "created",
- "type": "date"
+ "description": "the processor bit size",
+ "name": "bits",
+ "type": "int"
+ },
+ {
+ "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": "Lists the download progress of a template across all secondary storages",
+ "name": "downloaddetails",
+ "type": "list"
},
{
"description": "the ID of the zone for this template",
@@ -37946,19 +38627,14 @@
},
{},
{
- "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 template ID of the parent template if present",
- "name": "sourcetemplateid",
- "type": "string"
- },
- {
- "description": "the project name of the template",
- "name": "project",
- "type": "string"
+ "description": "the size of the template",
+ "name": "size",
+ "type": "long"
},
{
"description": "the status of the template",
@@ -37966,18 +38642,38 @@
"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 for this template",
+ "name": "zonename",
+ "type": "string"
},
{
- "description": "Lists the download progress of a template across all secondary storages",
- "name": "downloaddetails",
- "type": "list"
+ "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory",
+ "name": "isdynamicallyscalable",
+ "type": "boolean"
},
{
- "description": "the hypervisor on which the template runs",
- "name": "hypervisor",
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage",
+ "name": "directdownload",
+ "type": "boolean"
+ },
+ {
+ "description": "the project name of the template",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "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",
"type": "string"
},
{
@@ -37985,23 +38681,18 @@
"name": "tags",
"response": [
{
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
"description": "resource type",
"name": "resourcetype",
"type": "string"
},
{
- "description": "customer associated with the tag",
- "name": "customer",
+ "description": "id of the resource",
+ "name": "resourceid",
"type": "string"
},
{
- "description": "tag value",
- "name": "value",
+ "description": "the project name where tag belongs to",
+ "name": "project",
"type": "string"
},
{
@@ -38010,6 +38701,16 @@
"type": "string"
},
{
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
"description": "the account associated with the tag",
"name": "account",
"type": "string"
@@ -38020,32 +38721,27 @@
"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",
+ "description": "customer associated with the tag",
+ "name": "customer",
"type": "string"
}
],
"type": "set"
},
{
- "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 type of the template",
+ "name": "templatetype",
+ "type": "string"
},
{
- "description": "checksum of the template",
- "name": "checksum",
- "type": "string"
+ "description": "the format of the template.",
+ "name": "format",
+ "type": "imageformat"
},
{
"description": "true if template requires HVM enabled, false otherwise",
@@ -38053,165 +38749,14 @@
"type": "boolean"
},
{
- "description": "the name of the secondary storage host for the template",
- "name": "hostname",
- "type": "string"
- },
- {
- "description": "true if this template is a public template, false otherwise",
- "name": "ispublic",
- "type": "boolean"
- },
- {
"description": "the template name",
"name": "name",
"type": "string"
},
{
- "description": "the template display text",
- "name": "displaytext",
- "type": "string"
- },
- {
- "description": "the processor bit size",
- "name": "bits",
- "type": "int"
- },
- {
- "description": "VMware only: additional key/value details tied with deploy-as-is template",
- "name": "deployasisdetails",
- "type": "map"
- },
- {
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
- },
- {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
- },
- {
- "description": "the name of the OS type for this template.",
- "name": "ostypename",
- "type": "string"
- },
- {
- "description": "the account name to which the template belongs",
- "name": "account",
- "type": "string"
- },
- {
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "the tag of this template",
- "name": "templatetag",
- "type": "string"
- },
- {
- "description": "if Datadisk template, then id of the root disk template this template belongs to",
- "name": "parenttemplateid",
- "type": "string"
- },
- {
- "description": "the physical size of the template",
- "name": "physicalsize",
- "type": "long"
- },
- {
- "description": "true if template is sshkey enabled, false otherwise",
- "name": "sshkeyenabled",
- "type": "boolean"
- },
- {
- "description": "the size of the template",
- "name": "size",
- "type": "long"
- },
- {
- "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 template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory",
- "name": "isdynamicallyscalable",
- "type": "boolean"
- },
- {
- "description": "the name of the zone for this template",
- "name": "zonename",
- "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",
- "type": "boolean"
- },
- {
- "description": "true if the template is managed across all Zones, false otherwise",
- "name": "crossZones",
- "type": "boolean"
- },
- {},
- {
- "description": "additional key/value details tied with template",
- "name": "details",
- "type": "map"
- },
- {
- "description": "the ID of the domain to which the template belongs",
- "name": "domainid",
- "type": "string"
- },
- {
- "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 date this template was removed",
- "name": "removed",
- "type": "date"
- },
- {
- "description": "the URL which the template/iso is registered from",
- "name": "url",
- "type": "string"
- },
- {
- "description": "true if the reset password feature is enabled, false otherwise",
- "name": "passwordenabled",
- "type": "boolean"
- },
- {
- "description": "the ID of the OS type for this template.",
- "name": "ostypeid",
- "type": "string"
- },
- {
- "description": "the project id of the template",
- "name": "projectid",
- "type": "string"
}
]
},
@@ -38229,24 +38774,48 @@
"type": "uuid"
},
{
+ "description": "the name of the account which needs dedication. Must be used with domainId.",
+ "length": 255,
+ "name": "account",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "the ID of the containing domain",
"length": 255,
"name": "domainid",
"related": "createDomain,listDomainChildren,listDomains,listDomains",
"required": true,
"type": "uuid"
- },
- {
- "description": "the name of the account which needs dedication. Must be used with domainId.",
- "length": 255,
- "name": "account",
- "required": false,
- "type": "string"
}
],
"related": "",
"response": [
- {},
+ {
+ "description": "the Name of the Zone",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "the Account Id to which the Zone is dedicated",
+ "name": "accountid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the dedicated resource",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the Dedication Affinity Group ID of the zone",
+ "name": "affinitygroupid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the Zone",
+ "name": "zoneid",
+ "type": "string"
+ },
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
@@ -38257,37 +38826,13 @@
"name": "jobid",
"type": "string"
},
- {
- "description": "the ID of the Zone",
- "name": "zoneid",
- "type": "string"
- },
{},
{
"description": "the domain ID to which the Zone is dedicated",
"name": "domainid",
"type": "string"
},
- {
- "description": "the Dedication Affinity Group ID of the zone",
- "name": "affinitygroupid",
- "type": "string"
- },
- {
- "description": "the ID of the dedicated resource",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the Account Id to which the Zone is dedicated",
- "name": "accountid",
- "type": "string"
- },
- {
- "description": "the Name of the Zone",
- "name": "zonename",
- "type": "string"
- }
+ {}
]
},
{
@@ -38304,28 +38849,23 @@
"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"
- },
- {
"description": "the ID of the load balancer rule",
"length": 255,
"name": "id",
"related": "listPortForwardingRules,updatePortForwardingRule",
"required": true,
"type": "uuid"
+ },
+ {
+ "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": [
- {
- "description": "true if operation is executed successfully",
- "name": "success",
- "type": "boolean"
- },
{},
{
"description": "any text associated with the success or failure",
@@ -38333,16 +38873,21 @@
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "true if operation is executed successfully",
+ "name": "success",
+ "type": "boolean"
},
- {},
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
- }
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {}
]
},
{
@@ -38351,6 +38896,13 @@
"name": "listAsyncJobs",
"params": [
{
+ "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",
"length": 255,
"name": "domainid",
@@ -38359,6 +38911,20 @@
"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 start date of the async job (use format \"yyyy-MM-dd'T'HH:mm:ss'+'SSSS\")",
+ "length": 255,
+ "name": "startdate",
+ "required": false,
+ "type": "tzdate"
+ },
+ {
"description": "List by keyword",
"length": 255,
"name": "keyword",
@@ -38368,7 +38934,7 @@
{
"description": "",
"length": 255,
- "name": "page",
+ "name": "pagesize",
"required": false,
"type": "integer"
},
@@ -38380,32 +38946,11 @@
"type": "boolean"
},
{
- "description": "list resources by account. Must be used with the domainId parameter.",
- "length": 255,
- "name": "account",
- "required": false,
- "type": "string"
- },
- {
- "description": "The start date of the async job (use format \"yyyy-MM-dd'T'HH:mm:ss'+'SSSS\")",
- "length": 255,
- "name": "startdate",
- "required": false,
- "type": "tzdate"
- },
- {
"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.",
- "length": 255,
- "name": "isrecursive",
- "required": false,
- "type": "boolean"
}
],
"related": "queryAsyncJobResult",
@@ -38416,9 +38961,19 @@
"type": "date"
},
{
- "description": "the user that executed the async command",
- "name": "userid",
- "type": "string"
+ "description": " the created date of the job",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the result reason",
+ "name": "jobresult",
+ "type": "responseobject"
+ },
+ {
+ "description": "the result code for the job",
+ "name": "jobresultcode",
+ "type": "integer"
},
{
"description": "the account that executed the async command",
@@ -38426,19 +38981,13 @@
"type": "string"
},
{
- "description": "the result code for the job",
- "name": "jobresultcode",
- "type": "integer"
- },
- {},
- {
- "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 UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the result type",
+ "name": "jobresulttype",
"type": "string"
},
{
@@ -38447,23 +38996,19 @@
"type": "string"
},
{
- "description": " the created date of the job",
- "name": "created",
- "type": "date"
- },
- {
"description": "the progress information of the PENDING job",
"name": "jobprocstatus",
"type": "integer"
},
{
- "description": "the result reason",
- "name": "jobresult",
- "type": "responseobject"
+ "description": "the instance/entity object related to the job",
+ "name": "jobinstancetype",
+ "type": "string"
},
+ {},
{
- "description": "the result type",
- "name": "jobresulttype",
+ "description": "the user that executed the async command",
+ "name": "userid",
"type": "string"
},
{
@@ -38471,15 +39016,15 @@
"name": "jobstatus",
"type": "integer"
},
+ {
+ "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 async command executed",
- "name": "cmd",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
}
]
@@ -38490,20 +39035,6 @@
"name": "archiveAlerts",
"params": [
{
- "description": "start date range to archive alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")",
- "length": 255,
- "name": "startdate",
- "required": false,
- "type": "date"
- },
- {
- "description": "end date range to archive alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")",
- "length": 255,
- "name": "enddate",
- "required": false,
- "type": "date"
- },
- {
"description": "archive by alert type",
"length": 255,
"name": "type",
@@ -38517,6 +39048,20 @@
"related": "listAlerts",
"required": false,
"type": "list"
+ },
+ {
+ "description": "start date range to archive alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")",
+ "length": 255,
+ "name": "startdate",
+ "required": false,
+ "type": "date"
+ },
+ {
+ "description": "end date range to archive alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")",
+ "length": 255,
+ "name": "enddate",
+ "required": false,
+ "type": "date"
}
],
"response": [
@@ -38525,6 +39070,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",
@@ -38534,13 +39086,6 @@
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
- },
- {},
- {},
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
}
]
},
@@ -38559,6 +39104,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",
@@ -38566,21 +39116,16 @@
"type": "string"
},
{
+ "description": "true if operation is executed successfully",
+ "name": "success",
+ "type": "boolean"
+ },
+ {
"description": "any text associated with the success or failure",
"name": "displaytext",
"type": "string"
},
- {},
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "true if operation is executed successfully",
- "name": "success",
- "type": "boolean"
- }
+ {}
]
},
{
@@ -38607,169 +39152,260 @@
"related": "destroyRouter,listRouters,changeServiceForRouter,listInternalLoadBalancerVMs",
"response": [
{
- "description": "the id of the router",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the link local netmask for the router",
- "name": "linklocalnetmask",
- "type": "string"
- },
- {
- "description": "the state of redundant virtual router",
- "name": "redundantstate",
- "type": "string"
- },
- {
- "description": "true if any health checks had failed",
- "name": "healthchecksfailed",
- "type": "boolean"
- },
- {
- "description": "the version of scripts",
- "name": "scriptsversion",
- "type": "string"
- },
- {
- "description": "the ID of the corresponding guest network",
- "name": "guestnetworkid",
- "type": "string"
- },
- {
- "description": "the ID of the corresponding public network",
- "name": "publicnetworkid",
- "type": "string"
- },
- {
- "description": "the hypervisor on which the template runs",
- "name": "hypervisor",
- "type": "string"
- },
- {},
- {
- "description": "the template ID for the router",
- "name": "templateid",
- "type": "string"
- },
- {
- "description": "the project id of the ipaddress",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the first DNS for the router",
- "name": "dns1",
- "type": "string"
- },
- {
- "description": "the network domain for the router",
- "name": "networkdomain",
- "type": "string"
- },
- {
- "description": "the domain ID associated with the router",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the Zone name for the router",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "role of the domain router",
- "name": "role",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the name of the corresponding guest network",
- "name": "guestnetworkname",
- "type": "string"
- },
- {
- "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 link local MAC address for the router",
- "name": "linklocalmacaddress",
- "type": "string"
- },
- {
- "description": "the guest netmask for the router",
- "name": "guestnetmask",
- "type": "string"
- },
- {
- "description": "the host ID for the router",
- "name": "hostid",
- "type": "string"
- },
- {
- "description": "the public MAC address for the router",
- "name": "publicmacaddress",
- "type": "string"
- },
- {
"description": "true if the router template requires upgrader",
"name": "requiresupgrade",
"type": "boolean"
},
{
- "description": "if this router is an redundant virtual router",
- "name": "isredundantrouter",
- "type": "boolean"
- },
- {
"description": "the state of the router",
"name": "state",
"type": "state"
},
{
+ "description": "the list of nics associated with the router",
+ "name": "nic",
+ "response": [
+ {
+ "description": "the traffic type of the nic",
+ "name": "traffictype",
+ "type": "string"
+ },
+ {
+ "description": "true if nic is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {
+ "description": "the broadcast uri of the nic",
+ "name": "broadcasturi",
+ "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 NSX Logical Switch Port (if NSX based), null otherwise",
+ "name": "nsxlogicalswitchport",
+ "type": "string"
+ },
+ {
+ "description": "the netmask of the nic",
+ "name": "netmask",
+ "type": "string"
+ },
+ {
+ "description": "the name of the corresponding network",
+ "name": "networkname",
+ "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 vm to which the nic belongs",
+ "name": "virtualmachineid",
+ "type": "string"
+ },
+ {
+ "description": "IP addresses associated with NIC found for unmanaged VM",
+ "name": "ipaddresses",
+ "type": "list"
+ },
+ {
+ "description": "the ip address of the nic",
+ "name": "ipaddress",
+ "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 type of the nic",
+ "name": "type",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the nic",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the gateway of IPv6 network",
+ "name": "ip6gateway",
+ "type": "string"
+ },
+ {
+ "description": "the isolated private VLAN type if available",
+ "name": "isolatedpvlantype",
+ "type": "string"
+ },
+ {
+ "description": "Type of adapter if available",
+ "name": "adaptertype",
+ "type": "string"
+ },
+ {
+ "description": "the Secondary ipv4 addr of nic",
+ "name": "secondaryip",
+ "type": "list"
+ },
+ {
+ "description": "the isolation uri of the nic",
+ "name": "isolationuri",
+ "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": "ID of the VLAN/VNI if available",
+ "name": "vlanid",
+ "type": "integer"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the public MAC address for the router",
+ "name": "publicmacaddress",
+ "type": "string"
+ },
+ {
+ "description": "the id of the router",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the network domain for the router",
+ "name": "networkdomain",
+ "type": "string"
+ },
+ {
+ "description": "the second IPv6 DNS for the router",
+ "name": "ip6dns2",
+ "type": "string"
+ },
+ {
+ "description": "the template name for the router",
+ "name": "templatename",
+ "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": "the guest IP address for the router",
- "name": "guestipaddress",
- "type": "string"
- },
- {
- "description": "the name of the service offering of the virtual machine",
- "name": "serviceofferingname",
- "type": "string"
- },
- {
- "description": "the ID of the corresponding link local network",
- "name": "linklocalnetworkid",
- "type": "string"
- },
- {
"description": "the link local IP address for the router",
"name": "linklocalip",
"type": "string"
},
{
- "description": "the public IP address for the router",
- "name": "publicip",
+ "description": "the ID of the service offering of the virtual machine",
+ "name": "serviceofferingid",
+ "type": "string"
+ },
+ {
+ "description": "the date and time the router was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the host ID for the router",
+ "name": "hostid",
+ "type": "string"
+ },
+ {
+ "description": "the Pod ID for the router",
+ "name": "podid",
+ "type": "string"
+ },
+ {
+ "description": "the template ID for the router",
+ "name": "templateid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the corresponding guest network",
+ "name": "guestnetworkid",
+ "type": "string"
+ },
+ {
+ "description": "the guest MAC address for the router",
+ "name": "guestmacaddress",
+ "type": "string"
+ },
+ {
+ "description": "the second DNS for the router",
+ "name": "dns2",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the router",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the gateway for the router",
+ "name": "gateway",
+ "type": "string"
+ },
+ {
+ "description": "the link local netmask for the router",
+ "name": "linklocalnetmask",
+ "type": "string"
+ },
+ {
+ "description": "the Zone name for the router",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "the name of the router",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the corresponding link local network",
+ "name": "linklocalnetworkid",
"type": "string"
},
{
@@ -38778,30 +39414,55 @@
"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 ID of the corresponding public network",
+ "name": "publicnetworkid",
+ "type": "string"
+ },
+ {
+ "description": "the name of VPC the router belongs to",
+ "name": "vpcname",
+ "type": "string"
+ },
+ {
+ "description": "the name of the corresponding guest network",
+ "name": "guestnetworkname",
+ "type": "string"
+ },
+ {
+ "description": "the Pod name for the router",
+ "name": "podname",
+ "type": "string"
+ },
+ {
+ "description": "the first IPv6 DNS for the router",
+ "name": "ip6dns1",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
"description": "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 type of the health check - basic or advanced",
"name": "checktype",
"type": "string"
},
{
+ "description": "result of the health check",
+ "name": "success",
+ "type": "boolean"
+ },
+ {
"description": "the name of the health check on the router",
"name": "checkname",
"type": "string"
@@ -38810,160 +39471,18 @@
"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 version of template",
- "name": "version",
- "type": "string"
- },
- {
- "description": "the guest MAC address for the router",
- "name": "guestmacaddress",
- "type": "string"
- },
- {
- "description": "the list of nics associated with the router",
- "name": "nic",
- "response": [
- {
- "description": "Id of the vm to which the nic belongs",
- "name": "virtualmachineid",
- "type": "string"
- },
- {
- "description": "the isolation uri of the nic",
- "name": "isolationuri",
- "type": "string"
- },
- {
- "description": "true if nic is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
- },
- {
- "description": "the ip address of the nic",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "description": "device id for the network when plugged into the virtual machine",
- "name": "deviceid",
- "type": "string"
- },
- {
- "description": "the broadcast uri of the nic",
- "name": "broadcasturi",
- "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 gateway of IPv6 network",
- "name": "ip6gateway",
- "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 gateway of the nic",
- "name": "gateway",
- "type": "string"
- },
- {
- "description": "ID of the VLAN/VNI if available",
- "name": "vlanid",
- "type": "integer"
- },
- {
- "description": "the IPv6 address of network",
- "name": "ip6address",
- "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 Secondary ipv4 addr of nic",
- "name": "secondaryip",
- "type": "list"
- },
- {
- "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": "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",
- "type": "string"
- },
- {
- "description": "the name of the corresponding network",
- "name": "networkname",
- "type": "string"
- },
- {
- "description": "the traffic type of the nic",
- "name": "traffictype",
- "type": "string"
- },
- {
- "description": "the ID of the nic",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the ID of the corresponding network",
- "name": "networkid",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the template name for the router",
- "name": "templatename",
+ "description": "the link local MAC address for the router",
+ "name": "linklocalmacaddress",
"type": "string"
},
{
@@ -38972,49 +39491,58 @@
"type": "string"
},
{
- "description": "the name of the router",
- "name": "name",
+ "description": "role of the domain router",
+ "name": "role",
"type": "string"
},
{
- "description": "the gateway for the router",
- "name": "gateway",
+ "description": "the public IP address for the router",
+ "name": "publicip",
"type": "string"
},
{
- "description": "the ID of the service offering of the virtual machine",
- "name": "serviceofferingid",
+ "description": "the 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": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the guest netmask for the router",
+ "name": "guestnetmask",
"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 second DNS for the router",
- "name": "dns2",
+ "description": "true if any health checks had failed",
+ "name": "healthchecksfailed",
+ "type": "boolean"
+ },
+ {
+ "description": "the public netmask for the router",
+ "name": "publicnetmask",
"type": "string"
},
{
- "description": "the first IPv6 DNS for the router",
- "name": "ip6dns1",
- "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",
+ "description": "the version of scripts",
+ "name": "scriptsversion",
"type": "string"
},
{
- "description": "the Pod ID for the router",
- "name": "podid",
+ "description": "the state of redundant virtual router",
+ "name": "redundantstate",
"type": "string"
},
{
@@ -39022,15 +39550,32 @@
"name": "account",
"type": "string"
},
+ {},
+ {
+ "description": "the project id of the ipaddress",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the version of template",
+ "name": "version",
+ "type": "string"
+ },
+ {
+ "description": "the hypervisor on which the template runs",
+ "name": "hypervisor",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the first DNS for the router",
+ "name": "dns1",
+ "type": "string"
+ },
{
"description": "the hostname for the router",
"name": "hostname",
"type": "string"
- },
- {
- "description": "the date and time the router was created",
- "name": "created",
- "type": "date"
}
]
},
@@ -39040,13 +39585,6 @@
"name": "addBrocadeVcsDevice",
"params": [
{
- "description": "Hostname of ip address of the Brocade VCS Switch.",
- "length": 255,
- "name": "hostname",
- "required": true,
- "type": "string"
- },
- {
"description": "Credentials to access the Brocade VCS Switch API",
"length": 255,
"name": "username",
@@ -39062,6 +39600,13 @@
"type": "uuid"
},
{
+ "description": "Hostname of ip address of the Brocade VCS Switch.",
+ "length": 255,
+ "name": "hostname",
+ "required": true,
+ "type": "string"
+ },
+ {
"description": "Credentials to access the Brocade VCS Switch API",
"length": 255,
"name": "password",
@@ -39071,16 +39616,14 @@
],
"related": "listBrocadeVcsDevices",
"response": [
- {},
{
- "description": "the physical Network to which this Brocade VCS belongs to",
- "name": "physicalnetworkid",
+ "description": "name of the provider",
+ "name": "provider",
"type": "string"
},
- {},
{
- "description": "device id of the Brocade Vcs",
- "name": "vcsdeviceid",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
@@ -39088,24 +39631,26 @@
"name": "brocadedevicename",
"type": "string"
},
- {
- "description": "name of the provider",
- "name": "provider",
- "type": "string"
- },
- {
- "description": "the principal switch Ip address",
- "name": "hostname",
- "type": "string"
- },
+ {},
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
{
- "description": "the 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": "the principal switch Ip address",
+ "name": "hostname",
+ "type": "string"
+ },
+ {
+ "description": "device id of the Brocade Vcs",
+ "name": "vcsdeviceid",
"type": "string"
}
]
@@ -39142,8 +39687,23 @@
"related": "createSecurityGroup",
"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 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 domain ID of the security group",
+ "name": "domainid",
"type": "string"
},
{
@@ -39151,13 +39711,13 @@
"name": "ingressrule",
"response": [
{
- "description": "the id of the security group rule",
- "name": "ruleid",
+ "description": "security group name",
+ "name": "securitygroupname",
"type": "string"
},
{
- "description": "the starting IP of the security group rule",
- "name": "startport",
+ "description": "the code for the ICMP message response",
+ "name": "icmpcode",
"type": "integer"
},
{
@@ -39170,33 +39730,23 @@
"type": "string"
},
{
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
"description": "tag value",
"name": "value",
"type": "string"
},
{
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
"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",
"type": "string"
},
{
@@ -39205,31 +39755,31 @@
"type": "string"
},
{
- "description": "resource type",
- "name": "resourcetype",
+ "description": "customer associated with the tag",
+ "name": "customer",
"type": "string"
},
{
"description": "the account associated with the tag",
"name": "account",
"type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
}
],
"type": "set"
},
{
- "description": "the protocol of the security group rule",
- "name": "protocol",
- "type": "string"
- },
- {
- "description": "the CIDR notation for the base IP address of the security group rule",
- "name": "cidr",
- "type": "string"
- },
- {
- "description": "security group name",
- "name": "securitygroupname",
+ "description": "the id of the security group rule",
+ "name": "ruleid",
"type": "string"
},
{
@@ -39238,16 +39788,26 @@
"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 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"
@@ -39256,28 +39816,14 @@
"type": "set"
},
{},
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "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 project id the tag belongs to",
- "name": "projectid",
+ "description": "resource type",
+ "name": "resourcetype",
"type": "string"
},
{
@@ -39286,13 +39832,13 @@
"type": "string"
},
{
- "description": "resource type",
- "name": "resourcetype",
+ "description": "the domain associated with the tag",
+ "name": "domain",
"type": "string"
},
{
- "description": "tag key name",
- "name": "key",
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
"type": "string"
},
{
@@ -39301,11 +39847,6 @@
"type": "string"
},
{
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
"description": "id of the resource",
"name": "resourceid",
"type": "string"
@@ -39316,21 +39857,36 @@
"type": "string"
},
{
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
"description": "tag value",
"name": "value",
"type": "string"
},
{
- "description": "the domain associated with the tag",
- "name": "domain",
+ "description": "customer associated with the tag",
+ "name": "customer",
"type": "string"
}
],
"type": "set"
},
{
- "description": "the account owning the security group",
- "name": "account",
+ "description": "the project id of the group",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the domain name of the security group",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the name of the security group",
+ "name": "name",
"type": "string"
},
{
@@ -39338,83 +39894,37 @@
"name": "description",
"type": "string"
},
- {},
- {
- "description": "the ID of the security group",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the list of virtualmachine ids associated with this securitygroup",
- "name": "virtualmachineids",
- "type": "set"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the project name of the group",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the 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 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 starting IP of the security group rule",
"name": "startport",
"type": "integer"
},
{
- "description": "security group name",
- "name": "securitygroupname",
- "type": "string"
- },
- {
- "description": "the protocol of the security group rule",
- "name": "protocol",
- "type": "string"
- },
- {
- "description": "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": "the account associated with the tag",
- "name": "account",
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
"type": "string"
},
{
- "description": "the project id the tag belongs to",
- "name": "projectid",
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
"type": "string"
},
{
@@ -39428,8 +39938,18 @@
"type": "string"
},
{
- "description": "the project name where tag belongs to",
- "name": "project",
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
"type": "string"
},
{
@@ -39441,31 +39961,41 @@
"description": "the ID of the domain associated with the tag",
"name": "domainid",
"type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
}
],
"type": "set"
},
{
+ "description": "the id of the security group rule",
+ "name": "ruleid",
+ "type": "string"
+ },
+ {
"description": "the type of the ICMP message response",
"name": "icmptype",
"type": "integer"
},
{
+ "description": "the ending IP of the security group rule ",
+ "name": "endport",
+ "type": "integer"
+ },
+ {
+ "description": "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 code for the ICMP message response",
"name": "icmpcode",
"type": "integer"
@@ -39474,9 +40004,24 @@
"type": "set"
},
{
- "description": "the name of the security group",
- "name": "name",
+ "description": "the project name of the group",
+ "name": "project",
"type": "string"
+ },
+ {
+ "description": "the number of virtualmachines associated with this securitygroup",
+ "name": "virtualmachinecount",
+ "type": "integer"
+ },
+ {
+ "description": "the ID of the security group",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
}
],
"since": "4.14.0.0"
@@ -39487,13 +40032,6 @@
"name": "createDomain",
"params": [
{
- "description": "creates domain with this name",
- "length": 255,
- "name": "name",
- "required": true,
- "type": "string"
- },
- {
"description": "Domain UUID, required for adding domain from another Region",
"length": 255,
"name": "domainid",
@@ -39501,10 +40039,10 @@
"type": "string"
},
{
- "description": "Network domain for networks in the domain",
+ "description": "creates domain with this name",
"length": 255,
- "name": "networkdomain",
- "required": false,
+ "name": "name",
+ "required": true,
"type": "string"
},
{
@@ -39514,95 +40052,65 @@
"related": "createDomain,listDomainChildren,listDomains,listDomains",
"required": false,
"type": "uuid"
+ },
+ {
+ "description": "Network domain for networks in the domain",
+ "length": 255,
+ "name": "networkdomain",
+ "required": false,
+ "type": "string"
}
],
"related": "listDomainChildren,listDomains,listDomains",
"response": [
{
- "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 total number of vpcs available to be created for this domain",
- "name": "vpcavailable",
- "type": "string"
- },
- {
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {},
- {
- "description": "the total number of networks available to be created for this domain",
- "name": "networkavailable",
- "type": "string"
- },
- {
- "description": "the total number of templates which can be created by this domain",
- "name": "templatelimit",
- "type": "string"
- },
- {
- "description": "the total number of projects the domain can own",
- "name": "projectlimit",
- "type": "string"
- },
- {
"description": "the total number of networks the domain can own",
"name": "networklimit",
"type": "string"
},
{
+ "description": "the total number of cpu cores available to be created for this domain",
+ "name": "cpuavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of public ip addresses this domain can acquire",
+ "name": "iplimit",
+ "type": "string"
+ },
+ {
"description": "the total memory (in MB) available to be created for this domain",
"name": "memoryavailable",
"type": "string"
},
{
- "description": "the total number of networks owned by domain",
- "name": "networktotal",
- "type": "long"
+ "description": "the total number of templates which can be created by this domain",
+ "name": "templatelimit",
+ "type": "string"
},
{
- "description": "the total secondary storage space (in GiB) owned by domain",
- "name": "secondarystoragetotal",
- "type": "float"
+ "description": "the total number of cpu cores owned by domain",
+ "name": "cputotal",
+ "type": "long"
},
{
"description": "the total number of snapshots available for this domain",
"name": "snapshotavailable",
"type": "string"
},
- {},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the network domain",
+ "name": "networkdomain",
"type": "string"
},
{
- "description": "the date when this domain was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the domain name of the parent domain",
- "name": "parentdomainname",
- "type": "string"
- },
- {
- "description": "the total number of projects being administrated by this domain",
- "name": "projecttotal",
+ "description": "the total number of vpcs owned by domain",
+ "name": "vpctotal",
"type": "long"
},
{
- "description": "the total number of public ip addresses this domain can acquire",
- "name": "iplimit",
+ "description": "the total number of snapshots which can be stored by this domain",
+ "name": "snapshotlimit",
"type": "string"
},
{
@@ -39616,100 +40124,157 @@
"type": "long"
},
{
- "description": "the total memory (in MB) owned by domain",
- "name": "memorytotal",
+ "description": "the total number of snapshots stored by this domain",
+ "name": "snapshottotal",
"type": "long"
},
{
- "description": "whether the domain has one or more sub-domains",
- "name": "haschild",
- "type": "boolean"
- },
- {
- "description": "the total secondary storage space (in GiB) the domain can own",
- "name": "secondarystoragelimit",
- "type": "string"
- },
- {
- "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 memory (in MB) the domain can own",
- "name": "memorylimit",
- "type": "string"
- },
- {
- "description": "the level of the domain",
- "name": "level",
- "type": "integer"
- },
- {
"description": "the path of the domain",
"name": "path",
"type": "string"
},
{
- "description": "the network domain",
- "name": "networkdomain",
- "type": "string"
- },
- {
- "description": "the total number of virtual machines available for this domain to acquire",
- "name": "vmavailable",
- "type": "string"
- },
- {
- "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 name of the domain",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the total number of cpu cores the domain can own",
- "name": "cpulimit",
- "type": "string"
- },
- {
- "description": "the total number of projects available for administration by this domain",
- "name": "projectavailable",
- "type": "string"
- },
- {
"description": "the total number of templates which have been created by this domain",
"name": "templatetotal",
"type": "long"
},
{
- "description": "the domain ID of the parent domain",
- "name": "parentdomainid",
+ "description": "the total volume available for this domain",
+ "name": "volumeavailable",
"type": "string"
},
{
+ "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": "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 projects being administrated by this domain",
+ "name": "projecttotal",
+ "type": "long"
+ },
+ {
"description": "the total primary storage space (in GiB) available to be used for this domain",
"name": "primarystorageavailable",
"type": "string"
},
{
+ "description": "the domain ID of the parent domain",
+ "name": "parentdomainid",
+ "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 the domain can own",
+ "name": "cpulimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of public ip addresses allocated for this domain",
+ "name": "iptotal",
+ "type": "long"
+ },
+ {
+ "description": "the state of the domain",
+ "name": "state",
+ "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": "details for the domain",
+ "name": "domaindetails",
+ "type": "map"
+ },
+ {
+ "description": "the level of the domain",
+ "name": "level",
+ "type": "integer"
+ },
+ {
+ "description": "the total volume which can be used by this domain",
+ "name": "volumelimit",
+ "type": "string"
+ },
+ {
+ "description": "the total volume being used by this domain",
+ "name": "volumetotal",
+ "type": "long"
+ },
+ {},
+ {
+ "description": "the total number of projects available for administration by this domain",
+ "name": "projectavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total memory (in MB) the domain can own",
+ "name": "memorylimit",
+ "type": "string"
+ },
+ {
+ "description": "the total secondary storage space (in GiB) owned by domain",
+ "name": "secondarystoragetotal",
+ "type": "float"
+ },
+ {
+ "description": "the total number of networks available to be created for this domain",
+ "name": "networkavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of vpcs the domain can own",
+ "name": "vpclimit",
+ "type": "string"
+ },
+ {
"description": "the total number of virtual machines that can be deployed by this domain",
"name": "vmlimit",
"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 number of public ip addresses available for this domain to acquire",
+ "name": "ipavailable",
+ "type": "string"
+ },
{
"description": "the total number of templates available to be created by this domain",
"name": "templateavailable",
@@ -39721,102 +40286,21 @@
"type": "string"
},
{
- "description": "the total number of snapshots which can be stored by this domain",
- "name": "snapshotlimit",
+ "description": "the total secondary storage space (in GiB) available to be used for this domain",
+ "name": "secondarystorageavailable",
"type": "string"
},
{
- "description": "the total volume being used by this domain",
- "name": "volumetotal",
- "type": "long"
- },
- {
- "description": "the total volume available for this domain",
- "name": "volumeavailable",
+ "description": "the total secondary storage space (in GiB) the domain can own",
+ "name": "secondarystoragelimit",
"type": "string"
},
{
- "description": "the total number of 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 cpu cores owned by domain",
- "name": "cputotal",
- "type": "long"
- },
- {
- "description": "the total volume which can be used by this domain",
- "name": "volumelimit",
- "type": "string"
- },
- {
- "description": "the total number of public ip addresses allocated for this domain",
- "name": "iptotal",
- "type": "long"
- },
- {
- "description": "the total number of snapshots stored by this domain",
- "name": "snapshottotal",
- "type": "long"
- },
- {
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
- },
- {
- "description": "the total number of virtual machines deployed by this domain",
- "name": "vmtotal",
- "type": "long"
- },
- {
- "description": "the total number of vpcs the domain can own",
- "name": "vpclimit",
- "type": "string"
- }
- ]
- },
- {
- "description": "Deleting resource tag(s)",
- "isasync": true,
- "name": "deleteTags",
- "params": [
- {
- "description": "Delete tags matching key/value pairs",
- "length": 255,
- "name": "tags",
- "required": false,
- "type": "map"
- },
- {
- "description": "Delete tags for resource id(s)",
- "length": 255,
- "name": "resourceids",
- "required": true,
- "type": "list"
- },
- {
- "description": "Delete tag by resource type",
- "length": 255,
- "name": "resourcetype",
- "required": true,
- "type": "string"
- }
- ],
- "response": [
- {
- "description": "true if operation is executed successfully",
- "name": "success",
- "type": "boolean"
- },
- {
- "description": "any text associated with the success or failure",
- "name": "displaytext",
- "type": "string"
- },
- {},
- {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
@@ -39826,7 +40310,68 @@
"name": "jobstatus",
"type": "integer"
},
- {}
+ {
+ "description": "the name of the domain",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the total number of virtual machines available for this domain to acquire",
+ "name": "vmavailable",
+ "type": "string"
+ }
+ ]
+ },
+ {
+ "description": "Deleting resource tag(s)",
+ "isasync": true,
+ "name": "deleteTags",
+ "params": [
+ {
+ "description": "Delete tags for resource id(s)",
+ "length": 255,
+ "name": "resourceids",
+ "required": true,
+ "type": "list"
+ },
+ {
+ "description": "Delete tags matching key/value pairs",
+ "length": 255,
+ "name": "tags",
+ "required": false,
+ "type": "map"
+ },
+ {
+ "description": "Delete tag by resource type",
+ "length": 255,
+ "name": "resourcetype",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "response": [
+ {},
+ {},
+ {
+ "description": "the UUID 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.0.0"
},
@@ -39836,13 +40381,6 @@
"name": "listExternalFirewalls",
"params": [
{
- "description": "",
- "length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
- },
- {
"description": "List by keyword",
"length": 255,
"name": "keyword",
@@ -39850,6 +40388,13 @@
"type": "string"
},
{
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ },
+ {
"description": "zone Id",
"length": 255,
"name": "zoneid",
@@ -39860,83 +40405,83 @@
{
"description": "",
"length": 255,
- "name": "page",
+ "name": "pagesize",
"required": false,
"type": "integer"
}
],
"related": "",
"response": [
+ {},
{
- "description": "the private security zone of the external firewall",
- "name": "privatezone",
+ "description": "the public security zone of the external firewall",
+ "name": "publiczone",
"type": "string"
},
- {},
{
"description": "the zone ID of the external firewall",
"name": "zoneid",
"type": "string"
},
{
- "description": "the username that's used to log in to the external firewall",
- "name": "username",
- "type": "string"
- },
- {},
- {
- "description": "the private interface of the external firewall",
- "name": "privateinterface",
- "type": "string"
- },
- {
- "description": "the ID of the network device",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the timeout (in seconds) for requests to the external firewall",
- "name": "timeout",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the ID of the external firewall",
- "name": "id",
- "type": "string"
- },
- {
"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 current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "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",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the network device",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the external firewall",
+ "name": "id",
+ "type": "string"
+ },
+ {},
+ {
"description": "the management IP address of the external firewall",
"name": "ipaddress",
"type": "string"
},
{
+ "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",
+ "type": "string"
+ },
+ {
"description": "the usage interface of the external firewall",
"name": "usageinterface",
"type": "string"
},
{
- "description": "the public security zone of the external firewall",
- "name": "publiczone",
- "type": "string"
- },
- {
- "description": "the public interface of the external firewall",
- "name": "publicinterface",
+ "description": "the username that's used to log in to the external firewall",
+ "name": "username",
"type": "string"
}
]
@@ -39947,14 +40492,6 @@
"name": "restartNetwork",
"params": [
{
- "description": "The ID of the network to restart.",
- "length": 255,
- "name": "id",
- "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks",
- "required": true,
- "type": "uuid"
- },
- {
"description": "Turn the network into a network with redundant routers.",
"length": 255,
"name": "makeredundant",
@@ -39968,21 +40505,24 @@
"name": "cleanup",
"required": false,
"type": "boolean"
+ },
+ {
+ "description": "The ID of the network to restart.",
+ "length": 255,
+ "name": "id",
+ "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks",
+ "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",
@@ -39992,6 +40532,11 @@
"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"
}
]
},
@@ -40001,13 +40546,6 @@
"name": "login",
"params": [
{
- "description": "The id of the domain that the user belongs to. If both domain and domainId are passed in, \"domainId\" parameter takes precendence",
- "length": 255,
- "name": "domainId",
- "required": false,
- "type": "long"
- },
- {
"description": "Hashed password (Default is MD5). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.",
"length": 255,
"name": "password",
@@ -40015,6 +40553,13 @@
"type": "string"
},
{
+ "description": "The id of the domain that the user belongs to. If both domain and domainId are passed in, \"domainId\" parameter takes precendence",
+ "length": 255,
+ "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",
@@ -40032,6 +40577,42 @@
"related": "",
"response": [
{
+ "description": "Session key that can be passed in subsequent Query command calls",
+ "name": "sessionkey",
+ "type": "string"
+ },
+ {
+ "description": "user time zoneoffset",
+ "name": "timezoneoffset",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "user time zone",
+ "name": "timezone",
+ "type": "string"
+ },
+ {
+ "description": "Username",
+ "name": "username",
+ "type": "string"
+ },
+ {
+ "description": "the time period before the session has expired",
+ "name": "timeout",
+ "type": "integer"
+ },
+ {
+ "description": "the account name the user belongs to",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
"description": "Domain ID that the user belongs to",
"name": "domainid",
"type": "string"
@@ -40042,13 +40623,18 @@
"type": "string"
},
{
- "description": "user time zoneoffset",
- "name": "timezoneoffset",
+ "description": "first name of the user",
+ "name": "firstname",
"type": "string"
},
{
- "description": "Username",
- "name": "username",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "Is user registered",
+ "name": "registered",
"type": "string"
},
{
@@ -40057,52 +40643,11 @@
"type": "string"
},
{
- "description": "user time zone",
- "name": "timezone",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {},
- {
- "description": "Is user registered",
- "name": "registered",
- "type": "string"
- },
- {
- "description": "Session key that can be passed in subsequent Query command calls",
- "name": "sessionkey",
- "type": "string"
- },
- {
"description": "User ID",
"name": "userid",
"type": "string"
},
- {
- "description": "first name of the user",
- "name": "firstname",
- "type": "string"
- },
- {},
- {
- "description": "the account name the user belongs to",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the time period before the session has expired",
- "name": "timeout",
- "type": "integer"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- }
+ {}
]
},
{
@@ -40118,20 +40663,6 @@
"type": "integer"
},
{
- "description": "the hypervisor for which to restrict the search",
- "length": 255,
- "name": "hypervisor",
- "required": false,
- "type": "string"
- },
- {
- "description": "",
- "length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
- },
- {
"description": "List by keyword",
"length": 255,
"name": "keyword",
@@ -40145,46 +40676,58 @@
"related": "listHypervisorCapabilities",
"required": false,
"type": "uuid"
+ },
+ {
+ "description": "the hypervisor for which to restrict the search",
+ "length": 255,
+ "name": "hypervisor",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
}
],
"related": "",
"response": [
{
- "description": "the maximum number of guest vms recommended for this hypervisor",
- "name": "maxguestslimit",
- "type": "long"
- },
- {
- "description": "the ID of the hypervisor capabilities row",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the hypervisor version",
- "name": "hypervisorversion",
- "type": "string"
- },
- {},
- {
- "description": "the maximum number of Data Volumes that can be attached for this hypervisor",
- "name": "maxdatavolumeslimit",
+ "description": "the maximum number of Hosts per cluster for this hypervisor",
+ "name": "maxhostspercluster",
"type": "integer"
},
- {},
{
"description": "true if security group is supported",
"name": "securitygroupenabled",
"type": "boolean"
},
{
+ "description": "true if storage motion is supported",
+ "name": "storagemotionenabled",
+ "type": "boolean"
+ },
+ {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
{
- "description": "the hypervisor type",
- "name": "hypervisor",
- "type": "hypervisortype"
+ "description": "the hypervisor version",
+ "name": "hypervisorversion",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the hypervisor capabilities row",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the maximum number of Data Volumes that can be attached for this hypervisor",
+ "name": "maxdatavolumeslimit",
+ "type": "integer"
},
{
"description": "the current status of the latest async job acting on this object",
@@ -40192,15 +40735,17 @@
"type": "integer"
},
{
- "description": "true if storage motion is supported",
- "name": "storagemotionenabled",
- "type": "boolean"
+ "description": "the maximum number of guest vms recommended for this hypervisor",
+ "name": "maxguestslimit",
+ "type": "long"
},
+ {},
{
- "description": "the maximum number of Hosts per cluster for this hypervisor",
- "name": "maxhostspercluster",
- "type": "integer"
- }
+ "description": "the hypervisor type",
+ "name": "hypervisor",
+ "type": "hypervisortype"
+ },
+ {}
],
"since": "3.0.0"
},
@@ -40210,13 +40755,6 @@
"name": "addImageStore",
"params": [
{
- "description": "the image store provider name",
- "length": 255,
- "name": "provider",
- "required": true,
- "type": "string"
- },
- {
"description": "the URL for the image store",
"length": 2048,
"name": "url",
@@ -40224,6 +40762,13 @@
"type": "string"
},
{
+ "description": "the image store provider name",
+ "length": 255,
+ "name": "provider",
+ "required": true,
+ "type": "string"
+ },
+ {
"description": "the Zone ID for the image store",
"length": 255,
"name": "zoneid",
@@ -40249,28 +40794,19 @@
"related": "addSecondaryStorage,listSwifts,addImageStoreS3,listImageStores,updateCloudToUseObjectStore",
"response": [
{
- "description": "the ID of the image store",
- "name": "id",
- "type": "string"
- },
- {
"description": "the Zone ID of the image store",
"name": "zoneid",
"type": "string"
},
+ {},
{
- "description": "the url of the image store",
- "name": "url",
+ "description": "the provider name of the image store",
+ "name": "providername",
"type": "string"
},
{
- "description": "the protocol of the image store",
- "name": "protocol",
- "type": "string"
- },
- {
- "description": "the name of the image store",
- "name": "name",
+ "description": "the Zone name of the image store",
+ "name": "zonename",
"type": "string"
},
{
@@ -40279,25 +40815,19 @@
"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 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 current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "the url of the image store",
+ "name": "url",
+ "type": "string"
},
{
"description": "defines if store is read-only",
@@ -40305,19 +40835,34 @@
"type": "boolean"
},
{
- "description": "the Zone name of the image store",
- "name": "zonename",
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {},
+ {
+ "description": "the host's currently used disk size",
+ "name": "disksizeused",
+ "type": "long"
+ },
+ {
+ "description": "the ID of the image store",
+ "name": "id",
"type": "string"
},
{
+ "description": "the 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",
+ "description": "the name of the image store",
+ "name": "name",
"type": "string"
}
],
@@ -40329,12 +40874,11 @@
"name": "revokeTemplateDirectDownloadCertificate",
"params": [
{
- "description": "zone to revoke certificate",
+ "description": "hypervisor type",
"length": 255,
- "name": "zoneid",
- "related": "createZone,updateZone,listZones,listZones",
+ "name": "hypervisor",
"required": true,
- "type": "uuid"
+ "type": "string"
},
{
"description": "(optional) the host ID to revoke certificate",
@@ -40345,32 +40889,22 @@
"type": "uuid"
},
{
+ "description": "zone to revoke certificate",
+ "length": 255,
+ "name": "zoneid",
+ "related": "createZone,updateZone,listZones,listZones",
+ "required": true,
+ "type": "uuid"
+ },
+ {
"description": "alias of the SSL certificate",
"length": 255,
"name": "name",
"required": true,
"type": "string"
- },
- {
- "description": "hypervisor type",
- "length": 255,
- "name": "hypervisor",
- "required": true,
- "type": "string"
}
],
"response": [
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "any text associated with the success or failure",
- "name": "displaytext",
- "type": "string"
- },
- {},
{},
{
"description": "the current status of the latest async job acting on this object",
@@ -40378,10 +40912,21 @@
"type": "integer"
},
{
+ "description": "any text associated with the success or failure",
+ "name": "displaytext",
+ "type": "string"
+ },
+ {
"description": "true if operation is executed successfully",
"name": "success",
"type": "boolean"
- }
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {}
],
"since": "4.13"
},
@@ -40402,13 +40947,13 @@
"related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool",
"response": [
{
- "description": "the Zone ID of the storage pool",
- "name": "zoneid",
+ "description": "the IP address of the storage pool",
+ "name": "ipaddress",
"type": "string"
},
{
- "description": "the IP address of the storage pool",
- "name": "ipaddress",
+ "description": "the Zone name of the storage pool",
+ "name": "zonename",
"type": "string"
},
{
@@ -40417,8 +40962,50 @@
"type": "string"
},
{
- "description": "the storage pool path",
- "name": "path",
+ "description": "the name of the storage pool",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the total disk size of the storage pool",
+ "name": "disksizetotal",
+ "type": "long"
+ },
+ {
+ "description": "the storage pool capabilities",
+ "name": "storagecapabilities",
+ "type": "map"
+ },
+ {
+ "description": "the ID of the cluster for the storage pool",
+ "name": "clusterid",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the host's currently used disk size",
+ "name": "disksizeused",
+ "type": "long"
+ },
+ {},
+ {},
+ {
+ "description": "true if this pool is suitable to migrate a volume, false otherwise",
+ "name": "suitableformigration",
+ "type": "boolean"
+ },
+ {
+ "description": "the overprovisionfactor for the storage pool",
+ "name": "overprovisionfactor",
"type": "string"
},
{
@@ -40427,9 +41014,9 @@
"type": "long"
},
{
- "description": "the state of the storage pool",
- "name": "state",
- "type": "storagepoolstatus"
+ "description": "the Pod ID of the storage pool",
+ "name": "podid",
+ "type": "string"
},
{
"description": "the tags for the storage pool",
@@ -40442,70 +41029,13 @@
"type": "string"
},
{
- "description": "the ID of the cluster for the storage pool",
- "name": "clusterid",
+ "description": "the hypervisor type of the storage pool",
+ "name": "hypervisor",
"type": "string"
},
{
- "description": "the date and time the storage pool was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the name of the cluster for the storage pool",
- "name": "clustername",
- "type": "string"
- },
- {
- "description": "the total disk size of the storage pool",
- "name": "disksizetotal",
- "type": "long"
- },
- {
- "description": "true if this pool is suitable to migrate a volume, false otherwise",
- "name": "suitableformigration",
- "type": "boolean"
- },
- {
- "description": "the host's currently allocated disk size",
- "name": "disksizeallocated",
- "type": "long"
- },
- {
- "description": "the Pod ID of the storage pool",
- "name": "podid",
- "type": "string"
- },
- {},
- {},
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the name of the storage pool",
- "name": "name",
- "type": "string"
- },
- {
- "description": "Storage provider for this pool",
- "name": "provider",
- "type": "string"
- },
- {
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "the storage pool type",
- "name": "type",
- "type": "string"
- },
- {
- "description": "the scope of the storage pool",
- "name": "scope",
+ "description": "the storage pool path",
+ "name": "path",
"type": "string"
},
{
@@ -40514,8 +41044,13 @@
"type": "long"
},
{
- "description": "the hypervisor type of the storage pool",
- "name": "hypervisor",
+ "description": "the date and time the storage pool was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "Storage provider for this pool",
+ "name": "provider",
"type": "string"
},
{
@@ -40524,23 +41059,33 @@
"type": "string"
},
{
- "description": "the host's currently used disk size",
- "name": "disksizeused",
+ "description": "the state of the storage pool",
+ "name": "state",
+ "type": "storagepoolstatus"
+ },
+ {
+ "description": "the host's currently allocated disk size",
+ "name": "disksizeallocated",
"type": "long"
},
{
- "description": "the storage pool capabilities",
- "name": "storagecapabilities",
- "type": "map"
- },
- {
- "description": "the overprovisionfactor for the storage pool",
- "name": "overprovisionfactor",
+ "description": "the Zone ID of the storage pool",
+ "name": "zoneid",
"type": "string"
},
{
- "description": "the Zone name of the storage pool",
- "name": "zonename",
+ "description": "the name of the cluster for the storage pool",
+ "name": "clustername",
+ "type": "string"
+ },
+ {
+ "description": "the scope of the storage pool",
+ "name": "scope",
+ "type": "string"
+ },
+ {
+ "description": "the storage pool type",
+ "name": "type",
"type": "string"
}
],
@@ -40570,27 +41115,27 @@
],
"response": [
{
+ "description": "any text associated with the success or failure",
+ "name": "displaytext",
+ "type": "string"
+ },
+ {},
+ {
"description": "true if operation is executed successfully",
"name": "success",
"type": "boolean"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {},
- {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
+ {},
{
- "description": "any text associated 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.15.0"
},
@@ -40621,18 +41166,18 @@
"name": "jobstatus",
"type": "integer"
},
+ {},
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
- {},
- {},
{
"description": "SolidFire Account ID",
"name": "solidFireAccountId",
"type": "long"
- }
+ },
+ {}
]
},
{
@@ -40641,13 +41186,6 @@
"name": "listSupportedNetworkServices",
"params": [
{
- "description": "",
- "length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
- },
- {
"description": "List by keyword",
"length": 255,
"name": "keyword",
@@ -40655,6 +41193,13 @@
"type": "string"
},
{
+ "description": "network service provider name",
+ "length": 255,
+ "name": "provider",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "",
"length": 255,
"name": "pagesize",
@@ -40669,33 +41214,28 @@
"type": "string"
},
{
- "description": "network service provider name",
+ "description": "",
"length": 255,
- "name": "provider",
+ "name": "page",
"required": false,
- "type": "string"
+ "type": "integer"
}
],
"related": "",
"response": [
{},
{
- "description": "the service name",
- "name": "name",
- "type": "string"
- },
- {
"description": "the list of capabilities",
"name": "capability",
"response": [
{
- "description": "the capability value",
- "name": "value",
+ "description": "the capability name",
+ "name": "name",
"type": "string"
},
{
- "description": "the capability name",
- "name": "name",
+ "description": "the capability value",
+ "name": "value",
"type": "string"
},
{
@@ -40706,25 +41246,14 @@
],
"type": "list"
},
- {},
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
{
"description": "the service provider name",
"name": "provider",
"response": [
{
- "description": "true if individual services can be enabled/disabled",
- "name": "canenableindividualservice",
- "type": "boolean"
+ "description": "the physical network this belongs to",
+ "name": "physicalnetworkid",
+ "type": "string"
},
{
"description": "uuid of the network provider",
@@ -40732,32 +41261,48 @@
"type": "string"
},
{
+ "description": "services for this provider",
+ "name": "servicelist",
+ "type": "list"
+ },
+ {
"description": "the provider name",
"name": "name",
"type": "string"
},
{
+ "description": "true if individual services can be enabled/disabled",
+ "name": "canenableindividualservice",
+ "type": "boolean"
+ },
+ {
"description": "state of the network provider",
"name": "state",
"type": "string"
},
{
- "description": "the physical network this belongs to",
- "name": "physicalnetworkid",
- "type": "string"
- },
- {
"description": "the destination physical network",
"name": "destinationphysicalnetworkid",
"type": "string"
- },
- {
- "description": "services for this provider",
- "name": "servicelist",
- "type": "list"
}
],
"type": "list"
+ },
+ {
+ "description": "the service name",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
}
],
"since": "3.0.0"
@@ -40779,30 +41324,25 @@
"related": "",
"response": [
{
- "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",
"type": "string"
},
- {
- "description": "the description of the role permission",
- "name": "description",
- "type": "string"
- },
- {},
{},
{
"description": "the api name or wildcard rule",
"name": "rule",
"type": "string"
},
+ {},
{
- "description": "the 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 name of the role to which the role permission belongs",
+ "name": "rolename",
"type": "string"
},
{
@@ -40811,14 +41351,19 @@
"type": "integer"
},
{
- "description": "the name of the role to which the role permission belongs",
- "name": "rolename",
+ "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 UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
}
],
"since": "4.9.0"
@@ -40838,27 +41383,27 @@
}
],
"response": [
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "any text associated with the success or failure",
- "name": "displaytext",
- "type": "string"
- },
- {},
{},
{
"description": "true if operation is executed successfully",
"name": "success",
"type": "boolean"
},
+ {},
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
+ },
+ {
+ "description": "any text associated with the success or failure",
+ "name": "displaytext",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
}
]
},
@@ -40868,28 +41413,6 @@
"name": "listDedicatedGuestVlanRanges",
"params": [
{
- "description": "physical network id of the guest VLAN range",
- "length": 255,
- "name": "physicalnetworkid",
- "related": "createPhysicalNetwork",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "",
- "length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
- },
- {
- "description": "the account with which the guest VLAN range is associated. Must be used with the domainId parameter.",
- "length": 255,
- "name": "account",
- "required": false,
- "type": "string"
- },
- {
"description": "project who will own the guest VLAN range",
"length": 255,
"name": "projectid",
@@ -40898,28 +41421,6 @@
"type": "uuid"
},
{
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
- },
- {
- "description": "",
- "length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
- },
- {
- "description": "list dedicated guest vlan ranges by id",
- "length": 255,
- "name": "id",
- "related": "listDedicatedGuestVlanRanges",
- "required": false,
- "type": "uuid"
- },
- {
"description": "zone of the guest VLAN range",
"length": 255,
"name": "zoneid",
@@ -40935,40 +41436,73 @@
"type": "string"
},
{
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "list dedicated guest vlan ranges by id",
+ "length": 255,
+ "name": "id",
+ "related": "listDedicatedGuestVlanRanges",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "physical network id of the guest VLAN range",
+ "length": 255,
+ "name": "physicalnetworkid",
+ "related": "createPhysicalNetwork",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "the account with which the guest VLAN range is associated. Must be used with the domainId parameter.",
+ "length": 255,
+ "name": "account",
+ "required": false,
+ "type": "string"
+ },
+ {
"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": "domainid",
"related": "listDomainChildren,listDomains,listDomains",
"required": false,
"type": "uuid"
+ },
+ {
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
}
],
"related": "",
"response": [
{
- "description": "the zone of the guest vlan range",
- "name": "zoneid",
- "type": "long"
- },
- {
"description": "the account of the guest VLAN range",
"name": "account",
"type": "string"
},
- {},
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
{
- "description": "the project id of the guest vlan range",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the ID of the guest VLAN range",
- "name": "id",
+ "description": "the project name of the guest vlan range",
+ "name": "project",
"type": "string"
},
{},
@@ -40978,13 +41512,18 @@
"type": "long"
},
{
- "description": "the domain name of the guest VLAN range",
- "name": "domain",
+ "description": "the zone of the guest vlan range",
+ "name": "zoneid",
+ "type": "long"
+ },
+ {
+ "description": "the domain ID of the guest VLAN range",
+ "name": "domainid",
"type": "string"
},
{
- "description": "the project name of the guest vlan range",
- "name": "project",
+ "description": "the ID of the guest VLAN range",
+ "name": "id",
"type": "string"
},
{
@@ -40993,14 +41532,20 @@
"type": "string"
},
{
- "description": "the domain ID of the guest VLAN range",
- "name": "domainid",
+ "description": "the domain name of the guest VLAN range",
+ "name": "domain",
"type": "string"
},
{
"description": "the guest VLAN range",
"name": "guestvlanrange",
"type": "string"
+ },
+ {},
+ {
+ "description": "the project id of the guest vlan range",
+ "name": "projectid",
+ "type": "string"
}
]
},
@@ -41010,21 +41555,6 @@
"name": "addNetworkServiceProvider",
"params": [
{
- "description": "the destination Physical Network ID to bridge to",
- "length": 255,
- "name": "destinationphysicalnetworkid",
- "related": "createPhysicalNetwork",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "the list of services to be enabled for this physical network service provider",
- "length": 255,
- "name": "servicelist",
- "required": false,
- "type": "list"
- },
- {
"description": "the Physical Network ID to add the provider to",
"length": 255,
"name": "physicalnetworkid",
@@ -41038,20 +41568,26 @@
"name": "name",
"required": true,
"type": "string"
+ },
+ {
+ "description": "the destination Physical Network ID to bridge to",
+ "length": 255,
+ "name": "destinationphysicalnetworkid",
+ "related": "createPhysicalNetwork",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "the list of services to be enabled for this physical network service provider",
+ "length": 255,
+ "name": "servicelist",
+ "required": false,
+ "type": "list"
}
],
"related": "listNetworkServiceProviders,listTrafficTypes",
"response": [
- {
- "description": "the destination physical network",
- "name": "destinationphysicalnetworkid",
- "type": "string"
- },
- {
- "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",
@@ -41063,6 +41599,27 @@
"type": "boolean"
},
{
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {},
+ {
+ "description": "the provider name",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "services for this provider",
+ "name": "servicelist",
+ "type": "list"
+ },
+ {
+ "description": "the destination physical network",
+ "name": "destinationphysicalnetworkid",
+ "type": "string"
+ },
+ {
"description": "state of the network provider",
"name": "state",
"type": "string"
@@ -41073,21 +41630,9 @@
"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": "services for this provider",
- "name": "servicelist",
- "type": "list"
}
],
"since": "3.0.0"
@@ -41098,18 +41643,39 @@
"name": "listNetworkACLs",
"params": [
{
- "description": "Lists network ACL Item with the specified ID",
+ "description": "list network ACL items by protocol",
"length": 255,
- "name": "id",
- "related": "createNetworkACL,listNetworkACLs,updateNetworkACLItem,moveNetworkAclItem",
+ "name": "protocol",
+ "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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false",
+ "length": 255,
+ "name": "listall",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "list network ACL items by network ID",
+ "length": 255,
+ "name": "networkid",
+ "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks",
"required": false,
"type": "uuid"
},
{
- "description": "list objects by project",
+ "description": "Lists network ACL Item with the specified ID",
"length": 255,
- "name": "projectid",
- "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject",
+ "name": "id",
+ "related": "createNetworkACL,listNetworkACLs,updateNetworkACLItem,moveNetworkAclItem",
"required": false,
"type": "uuid"
},
@@ -41121,29 +41687,6 @@
"type": "integer"
},
{
- "description": "list network ACL items by ACL ID",
- "length": 255,
- "name": "aclid",
- "related": "createNetworkACLList,listNetworkACLLists",
- "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 network ACL items by network ID",
- "length": 255,
- "name": "networkid",
- "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks",
- "required": false,
- "type": "uuid"
- },
- {
"description": "List by keyword",
"length": 255,
"name": "keyword",
@@ -41151,10 +41694,32 @@
"type": "string"
},
{
- "description": "list only resources belonging to the domain specified",
+ "description": "list network ACL items by action",
"length": 255,
- "name": "domainid",
- "related": "listDomainChildren,listDomains,listDomains",
+ "name": "action",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "List resources by tags (key/value pairs)",
+ "length": 255,
+ "name": "tags",
+ "required": false,
+ "type": "map"
+ },
+ {
+ "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter",
+ "length": 255,
+ "name": "fordisplay",
+ "required": false,
+ "since": "4.4",
+ "type": "boolean"
+ },
+ {
+ "description": "list objects by project",
+ "length": 255,
+ "name": "projectid",
+ "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject",
"required": false,
"type": "uuid"
},
@@ -41166,19 +41731,11 @@
"type": "string"
},
{
- "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false",
+ "description": "list resources by account. Must be used with the domainId parameter.",
"length": 255,
- "name": "listall",
+ "name": "account",
"required": false,
- "type": "boolean"
- },
- {
- "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter",
- "length": 255,
- "name": "fordisplay",
- "required": false,
- "since": "4.4",
- "type": "boolean"
+ "type": "string"
},
{
"description": "",
@@ -41188,84 +41745,36 @@
"type": "integer"
},
{
- "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
+ "description": "list only resources belonging to the domain specified",
"length": 255,
- "name": "isrecursive",
+ "name": "domainid",
+ "related": "listDomainChildren,listDomains,listDomains",
"required": false,
- "type": "boolean"
+ "type": "uuid"
},
{
- "description": "List resources by tags (key/value pairs)",
+ "description": "list network ACL items by ACL ID",
"length": 255,
- "name": "tags",
+ "name": "aclid",
+ "related": "createNetworkACLList,listNetworkACLLists",
"required": false,
- "type": "map"
- },
- {
- "description": "list network ACL items by action",
- "length": 255,
- "name": "action",
- "required": false,
- "type": "string"
- },
- {
- "description": "list network ACL items by protocol",
- "length": 255,
- "name": "protocol",
- "required": false,
- "type": "string"
+ "type": "uuid"
}
],
"related": "createNetworkACL,updateNetworkACLItem,moveNetworkAclItem",
"response": [
- {},
{
- "description": "the ending port of ACL's port range",
- "name": "endport",
- "type": "string"
- },
- {
- "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": "error code for this icmp message",
+ "name": "icmpcode",
+ "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",
- "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 project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
+ "description": "id of the resource",
+ "name": "resourceid",
"type": "string"
},
{
@@ -41274,24 +41783,101 @@
"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": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
"type": "string"
},
{
"description": "the project name where tag belongs to",
"name": "project",
"type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
}
],
"type": "list"
},
{
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "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": "the name of the ACL this item belongs to",
+ "name": "aclname",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the traffic type for the ACL",
+ "name": "traffictype",
+ "type": "string"
+ },
+ {
+ "description": "Number of the ACL Item",
+ "name": "number",
+ "type": "integer"
+ },
+ {
+ "description": "the state of the rule",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the ACL this item belongs to",
+ "name": "aclid",
+ "type": "string"
+ },
+ {
+ "description": "the protocol of the ACL",
+ "name": "protocol",
+ "type": "string"
+ },
+ {
+ "description": "is rule for display to the regular user",
+ "name": "fordisplay",
+ "type": "boolean"
+ },
+ {
"description": "Action of ACL Item. Allow/Deny",
"name": "action",
"type": "string"
@@ -41302,8 +41888,8 @@
"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"
},
{
@@ -41312,55 +41898,14 @@
"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",
+ "description": "type of the icmp message being sent",
+ "name": "icmptype",
"type": "integer"
},
{
- "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": "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": "is rule for display to the regular user",
- "name": "fordisplay",
- "type": "boolean"
- },
- {
- "description": "the ID of the ACL this item belongs to",
- "name": "aclid",
- "type": "string"
- },
- {
- "description": "the starting port of ACL's port range",
- "name": "startport",
- "type": "string"
}
]
},
@@ -41379,23 +41924,23 @@
}
],
"response": [
- {},
{
- "description": "true if operation is executed successfully",
- "name": "success",
- "type": "boolean"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
{
"description": "any text associated with the success or failure",
"name": "displaytext",
"type": "string"
},
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
{},
+ {},
+ {
+ "description": "true if operation is executed successfully",
+ "name": "success",
+ "type": "boolean"
+ },
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
@@ -41409,112 +41954,13 @@
"name": "createServiceOffering",
"params": [
{
- "description": "max iops of the compute offering",
+ "description": "the total memory of the service offering in MB",
"length": 255,
- "name": "maxiops",
- "required": false,
- "since": "4.4",
- "type": "long"
- },
- {
- "description": "The maximum number of CPUs to be set with Custom Computer Offering",
- "length": 255,
- "name": "maxcpunumber",
- "required": false,
- "since": "4.13",
- "type": "integer"
- },
- {
- "description": "The minimum number of CPUs to be set with Custom Computer Offering",
- "length": 255,
- "name": "mincpunumber",
- "required": false,
- "since": "4.13",
- "type": "integer"
- },
- {
- "description": "length (in seconds) of the burst",
- "length": 255,
- "name": "iopsreadratemaxlength",
- "required": false,
- "type": "long"
- },
- {
- "description": "the ID of the containing zone(s), null for public offerings",
- "length": 255,
- "name": "zoneid",
- "related": "createZone,updateZone,listZones,listZones",
- "required": false,
- "since": "4.13",
- "type": "list"
- },
- {
- "description": "burst io requests write rate of the disk offering",
- "length": 255,
- "name": "iopswriteratemax",
- "required": false,
- "type": "long"
- },
- {
- "description": "io requests write rate of the disk offering",
- "length": 255,
- "name": "iopswriterate",
- "required": false,
- "type": "long"
- },
- {
- "description": "is this a system vm offering",
- "length": 255,
- "name": "issystem",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "the CPU speed of the service offering in MHz.",
- "length": 255,
- "name": "cpuspeed",
+ "name": "memory",
"required": false,
"type": "integer"
},
{
- "description": "whether compute offering iops is custom or not",
- "length": 255,
- "name": "customizediops",
- "required": false,
- "since": "4.4",
- "type": "boolean"
- },
- {
- "description": "bytes read rate of the disk offering",
- "length": 255,
- "name": "bytesreadrate",
- "required": false,
- "type": "long"
- },
- {
- "description": "The maximum memroy size of the custom service offering in MB",
- "length": 255,
- "name": "maxmemory",
- "required": false,
- "since": "4.13",
- "type": "integer"
- },
- {
- "description": "true if virtual machine needs to be dynamically scalable of cpu or memory",
- "length": 255,
- "name": "dynamicscalingenabled",
- "required": false,
- "since": "4.16",
- "type": "boolean"
- },
- {
- "description": "the storage type of the service offering. Values are local and shared.",
- "length": 255,
- "name": "storagetype",
- "required": false,
- "type": "string"
- },
- {
"description": "Whether service offering size is custom or not",
"length": 255,
"name": "customized",
@@ -41523,64 +41969,13 @@
"type": "boolean"
},
{
- "description": "The minimum memroy size of the custom service offering in MB",
+ "description": "length (in seconds) of the burst",
"length": 255,
- "name": "minmemory",
+ "name": "bytesreadratemaxlength",
"required": false,
- "since": "4.13",
- "type": "integer"
- },
- {
- "description": "data transfer rate in megabits per second allowed. Supported only for non-System offering and system offerings having \"domainrouter\" systemvmtype",
- "length": 255,
- "name": "networkrate",
- "required": false,
- "type": "integer"
- },
- {
- "description": "the HA for the service offering",
- "length": 255,
- "name": "offerha",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "the CPU number of the service offering",
- "length": 255,
- "name": "cpunumber",
- "required": false,
- "type": "integer"
- },
- {
- "description": "the tags for this service offering.",
- "length": 255,
- "name": "tags",
- "required": false,
- "type": "string"
- },
- {
- "description": "min iops of the compute offering",
- "length": 255,
- "name": "miniops",
- "required": false,
- "since": "4.4",
"type": "long"
},
{
- "description": "the system VM type. Possible types are \"domainrouter\", \"consoleproxy\" and \"secondarystoragevm\".",
- "length": 255,
- "name": "systemvmtype",
- "required": false,
- "type": "string"
- },
- {
- "description": "the total memory of the service offering in MB",
- "length": 255,
- "name": "memory",
- "required": false,
- "type": "integer"
- },
- {
"description": "The deployment planner heuristics used to deploy a VM of this offering. If null, value of global config vm.deployment.planner is used",
"length": 255,
"name": "deploymentplanner",
@@ -41588,75 +41983,9 @@
"type": "string"
},
{
- "description": "burst bytes read rate of the disk offering",
+ "description": "the storage type of the service offering. Values are local and shared.",
"length": 255,
- "name": "bytesreadratemax",
- "required": false,
- "type": "long"
- },
- {
- "description": "restrict the CPU usage to committed service offering",
- "length": 255,
- "name": "limitcpuuse",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "io requests read rate of the disk offering",
- "length": 255,
- "name": "iopsreadrate",
- "required": false,
- "type": "long"
- },
- {
- "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": "burst requests read rate of the disk offering",
- "length": 255,
- "name": "iopsreadratemax",
- "required": false,
- "type": "long"
- },
- {
- "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": "isvolatile",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "the host tag for this service offering.",
- "length": 255,
- "name": "hosttags",
- "required": false,
- "type": "string"
- },
- {
- "description": "length (in seconds) of the burst",
- "length": 255,
- "name": "iopswriteratemaxlength",
- "required": false,
- "type": "long"
- },
- {
- "description": "the cache mode to use for this disk offering. none, writeback or writethrough",
- "length": 255,
- "name": "cachemode",
- "required": false,
- "since": "4.14",
- "type": "string"
- },
- {
- "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.",
- "length": 255,
- "name": "provisioningtype",
+ "name": "storagetype",
"required": false,
"type": "string"
},
@@ -41669,24 +41998,32 @@
"type": "integer"
},
{
- "description": "length (in seconds) of the burst",
+ "description": "The minimum number of CPUs to be set with Custom Computer Offering",
"length": 255,
- "name": "bytesreadratemaxlength",
+ "name": "mincpunumber",
+ "required": false,
+ "since": "4.13",
+ "type": "integer"
+ },
+ {
+ "description": "io requests write rate of the disk offering",
+ "length": 255,
+ "name": "iopswriterate",
"required": false,
"type": "long"
},
{
- "description": "the ID of the containing domain(s), null for public offerings",
+ "description": "The maximum memroy size of the custom service offering in MB",
"length": 255,
- "name": "domainid",
- "related": "listDomainChildren,listDomains,listDomains",
+ "name": "maxmemory",
"required": false,
- "type": "list"
+ "since": "4.13",
+ "type": "integer"
},
{
- "description": "length (in seconds) of the burst",
+ "description": "burst io requests write rate of the disk offering",
"length": 255,
- "name": "byteswriteratemaxlength",
+ "name": "iopswriteratemax",
"required": false,
"type": "long"
},
@@ -41698,6 +42035,51 @@
"type": "string"
},
{
+ "description": "true if virtual machine needs to be dynamically scalable of cpu or memory",
+ "length": 255,
+ "name": "dynamicscalingenabled",
+ "required": false,
+ "since": "4.16",
+ "type": "boolean"
+ },
+ {
+ "description": "length (in seconds) of the burst",
+ "length": 255,
+ "name": "iopswriteratemaxlength",
+ "required": false,
+ "type": "long"
+ },
+ {
+ "description": "The maximum number of CPUs to be set with Custom Computer Offering",
+ "length": 255,
+ "name": "maxcpunumber",
+ "required": false,
+ "since": "4.13",
+ "type": "integer"
+ },
+ {
+ "description": "burst bytes read rate of the disk offering",
+ "length": 255,
+ "name": "bytesreadratemax",
+ "required": false,
+ "type": "long"
+ },
+ {
+ "description": "The minimum memroy size of the custom service offering in MB",
+ "length": 255,
+ "name": "minmemory",
+ "required": false,
+ "since": "4.13",
+ "type": "integer"
+ },
+ {
+ "description": "io requests read rate of the disk offering",
+ "length": 255,
+ "name": "iopsreadrate",
+ "required": false,
+ "type": "long"
+ },
+ {
"description": "the name of the service offering",
"length": 255,
"name": "name",
@@ -41712,14 +42094,79 @@
"type": "long"
},
{
- "description": "the Root disk size in GB.",
+ "description": "the CPU number of the service offering",
"length": 255,
- "name": "rootdisksize",
+ "name": "cpunumber",
"required": false,
- "since": "4.15",
+ "type": "integer"
+ },
+ {
+ "description": "min iops of the compute offering",
+ "length": 255,
+ "name": "miniops",
+ "required": false,
+ "since": "4.4",
"type": "long"
},
{
+ "description": "whether compute offering iops is custom or not",
+ "length": 255,
+ "name": "customizediops",
+ "required": false,
+ "since": "4.4",
+ "type": "boolean"
+ },
+ {
+ "description": "the system VM type. Possible types are \"domainrouter\", \"consoleproxy\" and \"secondarystoragevm\".",
+ "length": 255,
+ "name": "systemvmtype",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "length (in seconds) of the burst",
+ "length": 255,
+ "name": "byteswriteratemaxlength",
+ "required": false,
+ "type": "long"
+ },
+ {
+ "description": "bytes read rate of the disk offering",
+ "length": 255,
+ "name": "bytesreadrate",
+ "required": false,
+ "type": "long"
+ },
+ {
+ "description": "the ID of the containing domain(s), null for public offerings",
+ "length": 255,
+ "name": "domainid",
+ "related": "listDomainChildren,listDomains,listDomains",
+ "required": false,
+ "type": "list"
+ },
+ {
+ "description": "is this a system vm offering",
+ "length": 255,
+ "name": "issystem",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "details for planner, used to store specific parameters",
+ "length": 255,
+ "name": "serviceofferingdetails",
+ "required": false,
+ "type": "map"
+ },
+ {
+ "description": "the host tag for this service offering.",
+ "length": 255,
+ "name": "hosttags",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "bytes write rate of the disk offering",
"length": 255,
"name": "byteswriterate",
@@ -41727,19 +42174,127 @@
"type": "long"
},
{
- "description": "details for planner, used to store specific parameters",
+ "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware",
"length": 255,
- "name": "serviceofferingdetails",
+ "name": "storagepolicy",
+ "related": "listVsphereStoragePolicies",
"required": false,
- "type": "map"
+ "since": "4.15",
+ "type": "uuid"
+ },
+ {
+ "description": "the HA for the service offering",
+ "length": 255,
+ "name": "offerha",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "the tags for this service offering.",
+ "length": 255,
+ "name": "tags",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "burst requests read rate of the disk offering",
+ "length": 255,
+ "name": "iopsreadratemax",
+ "required": false,
+ "type": "long"
+ },
+ {
+ "description": "restrict the CPU usage to committed service offering",
+ "length": 255,
+ "name": "limitcpuuse",
+ "required": false,
+ "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 CPU speed of the service offering in MHz.",
+ "length": 255,
+ "name": "cpuspeed",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "length (in seconds) of the burst",
+ "length": 255,
+ "name": "iopsreadratemaxlength",
+ "required": false,
+ "type": "long"
+ },
+ {
+ "description": "the Root disk size in GB.",
+ "length": 255,
+ "name": "rootdisksize",
+ "required": false,
+ "since": "4.15",
+ "type": "long"
+ },
+ {
+ "description": "the cache mode to use for this disk offering. none, writeback or writethrough",
+ "length": 255,
+ "name": "cachemode",
+ "required": false,
+ "since": "4.14",
+ "type": "string"
+ },
+ {
+ "description": "true if the virtual machine needs to be volatile so that on every reboot of VM, original root disk is dettached then destroyed and a fresh root disk is created and attached to VM",
+ "length": 255,
+ "name": "isvolatile",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "max iops of the compute offering",
+ "length": 255,
+ "name": "maxiops",
+ "required": false,
+ "since": "4.4",
+ "type": "long"
+ },
+ {
+ "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.",
+ "length": 255,
+ "name": "provisioningtype",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the ID of the containing zone(s), null for public offerings",
+ "length": 255,
+ "name": "zoneid",
+ "related": "createZone,updateZone,listZones,listZones",
+ "required": false,
+ "since": "4.13",
+ "type": "list"
}
],
"related": "updateServiceOffering,listServiceOfferings",
"response": [
{
- "description": "restrict the CPU usage to committed service offering",
- "name": "limitcpuuse",
- "type": "boolean"
+ "description": "length (in second) of the burst",
+ "name": "diskIopsReadRateMaxLength",
+ "type": "long"
+ },
+ {
+ "description": "data transfer rate in megabits per second allowed.",
+ "name": "networkrate",
+ "type": "integer"
+ },
+ {
+ "description": "additional key/value details tied with this service offering",
+ "name": "serviceofferingdetails",
+ "type": "map"
},
{
"description": "the host tag for the service offering",
@@ -41747,38 +42302,18 @@
"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": "burst bytes write rate of the disk offering",
"name": "diskBytesWriteRateMax",
"type": "long"
},
{
- "description": "length (in seconds) of the burst",
- "name": "diskBytesWriteRateMaxLength",
- "type": "long"
+ "description": "is true if the offering is customized",
+ "name": "iscustomized",
+ "type": "boolean"
},
{
- "description": "the name of the service offering",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the storage type for this service offering",
- "name": "storagetype",
- "type": "string"
- },
- {
- "description": "the tags for the service offering",
- "name": "storagetags",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
@@ -41787,89 +42322,43 @@
"type": "boolean"
},
{
+ "description": "bytes read rate of the service offering",
+ "name": "diskBytesReadRate",
+ "type": "long"
+ },
+ {
"description": "the cache mode to use for this disk offering. none, writeback or writethrough",
"name": "cacheMode",
"type": "string"
},
{
- "description": "burst io requests write rate of the disk offering",
- "name": "diskIopsWriteRateMax",
- "type": "long"
- },
- {
- "description": "length (in seconds) of the burst",
- "name": "diskIopsWriteRateMaxLength",
- "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": "is this a system vm offering",
+ "name": "issystem",
+ "type": "boolean"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
"description": "io requests write rate of the service offering",
"name": "diskIopsWriteRate",
"type": "long"
},
{
- "description": "is this a default system vm offering",
- "name": "defaultuse",
- "type": "boolean"
- },
- {
"description": "the number of CPU",
"name": "cpunumber",
"type": "integer"
},
{
- "description": "data transfer rate in megabits per second allowed.",
- "name": "networkrate",
- "type": "integer"
- },
- {
- "description": "the id of the service offering",
- "name": "id",
- "type": "string"
- },
- {},
- {
- "description": "Root disk size in GB",
- "name": "rootdisksize",
- "type": "long"
- },
- {
- "description": "additional key/value details tied with this service offering",
- "name": "serviceofferingdetails",
- "type": "map"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "burst bytes read rate of the disk offering",
- "name": "diskBytesReadRateMax",
- "type": "long"
- },
- {
- "description": "deployment strategy used to deploy VM.",
- "name": "deploymentplanner",
- "type": "string"
- },
- {
- "description": "the date this service offering was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "is this a the systemvm type for system vm offering",
- "name": "systemvmtype",
+ "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
+ "name": "zone",
"type": "string"
},
{
@@ -41878,28 +42367,115 @@
"type": "string"
},
{
- "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)",
- "name": "hypervisorsnapshotreserve",
+ "description": "length (in seconds) of the burst",
+ "name": "diskBytesReadRateMaxLength",
+ "type": "long"
+ },
+ {
+ "description": "the max iops of the disk offering",
+ "name": "maxiops",
+ "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",
"type": "integer"
},
+ {},
+ {
+ "description": "the memory in MB",
+ "name": "memory",
+ "type": "integer"
+ },
+ {
+ "description": "burst io requests write rate of the disk offering",
+ "name": "diskIopsWriteRateMax",
+ "type": "long"
+ },
+ {
+ "description": "Root disk size in GB",
+ "name": "rootdisksize",
+ "type": "long"
+ },
+ {
+ "description": "is this a default system vm offering",
+ "name": "defaultuse",
+ "type": "boolean"
+ },
+ {
+ "description": "length (in seconds) of the burst",
+ "name": "diskIopsWriteRateMaxLength",
+ "type": "long"
+ },
+ {
+ "description": "the min iops of the disk offering",
+ "name": "miniops",
+ "type": "long"
+ },
+ {
+ "description": "burst bytes read rate of the disk offering",
+ "name": "diskBytesReadRateMax",
+ "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": "length (in seconds) of the burst",
- "name": "diskBytesReadRateMaxLength",
+ "description": "burst io requests read rate of the disk offering",
+ "name": "diskIopsReadRateMax",
"type": "long"
},
{
- "description": "bytes read rate of the service offering",
- "name": "diskBytesReadRate",
- "type": "long"
+ "description": "the storage type for this service offering",
+ "name": "storagetype",
+ "type": "string"
},
{
- "description": "true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk",
- "name": "isvolatile",
+ "description": "the name of the service 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": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)",
+ "name": "hypervisorsnapshotreserve",
+ "type": "integer"
+ },
+ {
+ "description": "the vsphere storage policy tagged to the service offering in case of VMware",
+ "name": "vspherestoragepolicy",
+ "type": "string"
+ },
+ {
+ "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "io requests read rate of the service offering",
+ "name": "diskIopsReadRate",
+ "type": "long"
+ },
+ {},
+ {
+ "description": "is this a the systemvm type for system vm offering",
+ "name": "systemvmtype",
+ "type": "string"
+ },
+ {
+ "description": "restrict the CPU usage to committed service offering",
+ "name": "limitcpuuse",
"type": "boolean"
},
{
@@ -41908,19 +42484,29 @@
"type": "boolean"
},
{
- "description": "io requests read rate of the service offering",
- "name": "diskIopsReadRate",
+ "description": "true if disk offering uses custom iops, false otherwise",
+ "name": "iscustomizediops",
+ "type": "boolean"
+ },
+ {
+ "description": "true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk",
+ "name": "isvolatile",
+ "type": "boolean"
+ },
+ {
+ "description": "length (in seconds) of the burst",
+ "name": "diskBytesWriteRateMaxLength",
"type": "long"
},
{
- "description": "the memory in MB",
- "name": "memory",
- "type": "integer"
+ "description": "deployment strategy used to deploy VM.",
+ "name": "deploymentplanner",
+ "type": "string"
},
{
- "description": "the max iops of the disk offering",
- "name": "maxiops",
- "type": "long"
+ "description": "the tags for the service offering",
+ "name": "storagetags",
+ "type": "string"
},
{
"description": "the clock rate CPU speed in Mhz",
@@ -41928,55 +42514,14 @@
"type": "integer"
},
{
- "description": "burst io requests read rate of the disk offering",
- "name": "diskIopsReadRateMax",
+ "description": "the date this service offering was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "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 min iops of the disk offering",
- "name": "miniops",
- "type": "long"
- },
- {
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "the vsphere storage policy tagged to the service offering in case of VMware",
- "name": "vspherestoragepolicy",
- "type": "string"
- },
- {},
- {
- "description": "length (in second) of the burst",
- "name": "diskIopsReadRateMaxLength",
- "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": "is true if the offering is customized",
- "name": "iscustomized",
- "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 UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
}
]
},
@@ -41986,14 +42531,6 @@
"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.",
- "length": 255,
- "name": "destzoneids",
- "related": "createZone,updateZone,listZones,listZones",
- "required": false,
- "type": "list"
- },
- {
"description": "Template ID.",
"length": 255,
"name": "id",
@@ -42016,65 +42553,22 @@
"related": "createZone,updateZone,listZones,listZones",
"required": false,
"type": "uuid"
+ },
+ {
+ "description": "A list of IDs of the zones that the template needs to be copied to.Specify this list if the template needs to copied to multiple zones in one go. Do not specify destzoneid and destzoneids together, however one of them is required.",
+ "length": 255,
+ "name": "destzoneids",
+ "related": "createZone,updateZone,listZones,listZones",
+ "required": false,
+ "type": "list"
}
],
"related": "listIsos,registerIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos",
"response": [
{
- "description": "the size of the template",
- "name": "size",
- "type": "long"
- },
- {
- "description": "the template ID",
- "name": "id",
- "type": "string"
- },
- {
- "description": "true if the reset password feature is enabled, false otherwise",
- "name": "passwordenabled",
- "type": "boolean"
- },
- {
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
- },
- {
- "description": "true if template is sshkey enabled, false otherwise",
- "name": "sshkeyenabled",
- "type": "boolean"
- },
- {
- "description": "the format of the template.",
- "name": "format",
- "type": "imageformat"
- },
- {
- "description": "true if the template is extractable, false otherwise",
- "name": "isextractable",
- "type": "boolean"
- },
- {
- "description": "the URL which the template/iso is registered from",
- "name": "url",
- "type": "string"
- },
- {
- "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": "VMware only: additional key/value details tied with deploy-as-is template",
+ "name": "deployasisdetails",
+ "type": "map"
},
{
"description": "the ID of the secondary storage host for the template",
@@ -42082,178 +42576,17 @@
"type": "string"
},
{
- "description": "the date this template was removed",
- "name": "removed",
- "type": "date"
- },
- {
- "description": "true if the template is ready to be deployed from, false otherwise.",
- "name": "isready",
- "type": "boolean"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the hypervisor on which the template runs",
- "name": "hypervisor",
- "type": "string"
- },
- {
- "description": "additional key/value details tied with template",
- "name": "details",
- "type": "map"
- },
- {
- "description": "the name of the zone for this template",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "the account name to which the template belongs",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the processor bit size",
- "name": "bits",
- "type": "int"
- },
- {
- "description": "the ID of the zone for this template",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory",
- "name": "isdynamicallyscalable",
- "type": "boolean"
- },
- {
- "description": "the ID of the OS type for this template.",
- "name": "ostypeid",
- "type": "string"
- },
- {
- "description": "the template display text",
- "name": "displaytext",
- "type": "string"
- },
- {
- "description": "the template ID of the parent template if present",
- "name": "sourcetemplateid",
- "type": "string"
- },
- {
- "description": "the tag of this template",
- "name": "templatetag",
- "type": "string"
- },
- {},
- {
- "description": "Lists the download progress of a template across all secondary storages",
- "name": "downloaddetails",
- "type": "list"
- },
- {
"description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.",
"name": "deployasis",
"type": "boolean"
},
{
- "description": "the ID of the domain to which the template belongs",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the status of the template",
- "name": "status",
- "type": "string"
- },
- {
- "description": "the project id of the template",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the name of the OS type for this template.",
- "name": "ostypename",
- "type": "string"
- },
- {
- "description": "the name of the domain to which the template belongs",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "if root disk template, then ids of the datas disk templates this template owns",
- "name": "childtemplates",
- "type": "set"
- },
- {
- "description": "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 template requires HVM enabled, false otherwise",
- "name": "requireshvm",
- "type": "boolean"
- },
- {
- "description": "the account id to which the template belongs",
- "name": "accountid",
- "type": "string"
- },
- {
- "description": "true if the template is managed across all Zones, false otherwise",
- "name": "crossZones",
- "type": "boolean"
- },
- {
- "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage",
- "name": "directdownload",
- "type": "boolean"
- },
- {
- "description": "the project name of the template",
- "name": "project",
- "type": "string"
- },
- {
- "description": "true if the ISO is bootable, false otherwise",
- "name": "bootable",
- "type": "boolean"
- },
- {
- "description": "the type of the template",
- "name": "templatetype",
- "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",
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
"type": "string"
},
{
@@ -42262,8 +42595,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"
},
{
@@ -42272,11 +42605,6 @@
"type": "string"
},
{
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
"description": "id of the resource",
"name": "resourceid",
"type": "string"
@@ -42287,19 +42615,241 @@
"type": "string"
},
{
- "description": "the project id the tag belongs to",
- "name": "projectid",
+ "description": "tag key name",
+ "name": "key",
"type": "string"
},
{
"description": "customer associated with the tag",
"name": "customer",
"type": "string"
+ },
+ {
+ "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 account name to which the template belongs",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the URL which the template/iso is registered from",
+ "name": "url",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain to which the template belongs",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the template display text",
+ "name": "displaytext",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "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": "true if this template is a public template, false otherwise",
+ "name": "ispublic",
+ "type": "boolean"
+ },
+ {
+ "description": "if Datadisk template, then id of the root disk template this template belongs to",
+ "name": "parenttemplateid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "true if the template is managed across all Zones, false otherwise",
+ "name": "crossZones",
+ "type": "boolean"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the size of the template",
+ "name": "size",
+ "type": "long"
+ },
+ {},
+ {
+ "description": "the name of the zone for this template",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "true if template requires HVM enabled, false otherwise",
+ "name": "requireshvm",
+ "type": "boolean"
+ },
+ {
+ "description": "the date this template was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "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": "the hypervisor on which the template runs",
+ "name": "hypervisor",
+ "type": "string"
+ },
+ {
+ "description": "the format of the template.",
+ "name": "format",
+ "type": "imageformat"
+ },
+ {
+ "description": "the template name",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the name of the domain to which the template belongs",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "true if the 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": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "true if the reset password feature is enabled, false otherwise",
+ "name": "passwordenabled",
+ "type": "boolean"
+ },
+ {
+ "description": "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 template ID of the parent template if present",
+ "name": "sourcetemplateid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the zone for this template",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the date this template was removed",
+ "name": "removed",
+ "type": "date"
+ },
+ {
+ "description": "the ID of the OS type for this template.",
+ "name": "ostypeid",
+ "type": "string"
+ },
+ {
+ "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage",
+ "name": "directdownload",
+ "type": "boolean"
+ },
+ {
+ "description": "the physical size of the template",
+ "name": "physicalsize",
+ "type": "long"
+ },
+ {
+ "description": "true if the template is extractable, false otherwise",
+ "name": "isextractable",
+ "type": "boolean"
+ },
+ {
+ "description": "the project name of the template",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the status of the template",
+ "name": "status",
+ "type": "string"
+ },
+ {
+ "description": "the type of the template",
+ "name": "templatetype",
+ "type": "string"
+ },
+ {
+ "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory",
+ "name": "isdynamicallyscalable",
+ "type": "boolean"
+ },
+ {
+ "description": "true if this template is a featured template, false otherwise",
+ "name": "isfeatured",
+ "type": "boolean"
+ },
+ {
+ "description": "the tag of this template",
+ "name": "templatetag",
+ "type": "string"
+ },
+ {
+ "description": "the project id of the template",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the processor bit size",
+ "name": "bits",
+ "type": "int"
+ },
+ {
"description": "the name of the secondary storage host for the template",
"name": "hostname",
"type": "string"
@@ -42310,19 +42860,14 @@
"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",
+ "description": "the name of the OS type for this template.",
+ "name": "ostypename",
"type": "string"
},
{
- "description": "the physical size of the template",
- "name": "physicalsize",
- "type": "long"
+ "description": "true if template is sshkey enabled, false otherwise",
+ "name": "sshkeyenabled",
+ "type": "boolean"
}
]
},
@@ -42334,13 +42879,6 @@
{
"description": "",
"length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
- },
- {
- "description": "",
- "length": 255,
"name": "pagesize",
"required": false,
"type": "integer"
@@ -42359,48 +42897,36 @@
"name": "keyword",
"required": false,
"type": "string"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
}
],
"related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks",
"response": [
{
- "description": "true if network is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
+ "description": "the project name of the address",
+ "name": "project",
+ "type": "string"
},
+ {},
{
- "description": "Broadcast domain type of the network",
- "name": "broadcastdomaintype",
+ "description": "related to what other network configuration",
+ "name": "related",
"type": "string"
},
{
- "description": "the network domain",
- "name": "networkdomain",
+ "description": "the first DNS for the network",
+ "name": "dns1",
"type": "string"
},
{
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "Name of the VPC to which this network belongs",
- "name": "vpcname",
- "type": "string"
- },
- {
- "description": "ACL Id associated with the VPC network",
- "name": "aclid",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the total number of network traffic bytes received",
- "name": "receivedbytes",
+ "description": "the total number of network traffic bytes sent",
+ "name": "sentbytes",
"type": "long"
},
{
@@ -42409,221 +42935,75 @@
"type": "string"
},
{
- "description": "the network's gateway",
- "name": "gateway",
- "type": "string"
- },
- {
- "description": "the displaytext of the network",
- "name": "displaytext",
- "type": "string"
- },
- {
- "description": "the name of the zone the network belongs to",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "related to what other network configuration",
- "name": "related",
- "type": "string"
- },
- {
- "description": "availability of the network offering the network is created from",
- "name": "networkofferingavailability",
- "type": "string"
- },
- {
- "description": "zone id of the network",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "VPC the network belongs to",
- "name": "vpcid",
- "type": "string"
- },
- {
"description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR",
"name": "cidr",
"type": "string"
},
{
- "description": "the list of resource tags associated with network",
- "name": "tags",
- "response": [
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "tag 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"
- }
- ],
- "type": "list"
- },
- {
- "description": "the total number of network traffic bytes sent",
- "name": "sentbytes",
- "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",
- "type": "boolean"
- },
- {
- "description": "network offering id the network is created from",
- "name": "networkofferingid",
- "type": "string"
- },
- {
- "description": "the project id of the ipaddress",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "The external id of the network",
- "name": "externalid",
- "type": "string"
- },
- {
"description": "acl type - access type to the network",
"name": "acltype",
"type": "string"
},
{
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "zone id of the network",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the date this network was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "true if network can span multiple zones",
+ "name": "strechedl2subnet",
+ "type": "boolean"
+ },
+ {
+ "description": "true network requires restart",
+ "name": "restartrequired",
+ "type": "boolean"
+ },
+ {
+ "description": "Broadcast domain type of the network",
+ "name": "broadcastdomaintype",
+ "type": "string"
+ },
+ {
"description": "the name of the network",
"name": "name",
"type": "string"
},
{
- "description": "display text of the network offering the network is created from",
- "name": "networkofferingdisplaytext",
- "type": "string"
- },
- {
- "description": "the project name of the address",
- "name": "project",
- "type": "string"
- },
- {
- "description": "true if network supports specifying ip ranges, false otherwise",
- "name": "specifyipranges",
+ "description": "true if users from subdomains can access the domain level network",
+ "name": "subdomainaccess",
"type": "boolean"
},
{
- "description": "state of the network",
- "name": "state",
+ "description": "the network domain",
+ "name": "networkdomain",
"type": "string"
},
+ {},
{
- "description": "the network's netmask",
- "name": "netmask",
+ "description": "the physical network id",
+ "name": "physicalnetworkid",
"type": "string"
},
{
- "description": "list networks available for vm deployment",
- "name": "canusefordeploy",
- "type": "boolean"
- },
- {
- "description": "the domain id of the network owner",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "an optional field, whether to the display the network to the end user or not.",
- "name": "displaynetwork",
- "type": "boolean"
- },
- {
- "description": "the id of the network",
- "name": "id",
- "type": "string"
- },
- {
- "description": "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": "true if network is system, false otherwise",
- "name": "issystem",
- "type": "boolean"
- },
- {
"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": "true if individual services can be enabled/disabled",
- "name": "canenableindividualservice",
- "type": "boolean"
- },
- {
"description": "state of the network provider",
"name": "state",
"type": "string"
@@ -42639,24 +43019,34 @@
"type": "string"
},
{
- "description": "the provider name",
- "name": "name",
+ "description": "the physical network this belongs to",
+ "name": "physicalnetworkid",
"type": "string"
},
{
- "description": "the physical network this belongs to",
- "name": "physicalnetworkid",
+ "description": "the provider name",
+ "name": "name",
"type": "string"
},
{
"description": "uuid of the network provider",
"name": "id",
"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": [
@@ -42666,14 +43056,14 @@
"type": "string"
},
{
- "description": "can this service capability value can be choosable while creatine network offerings",
- "name": "canchooseservicecapability",
- "type": "boolean"
- },
- {
"description": "the capability value",
"name": "value",
"type": "string"
+ },
+ {
+ "description": "can this service capability value can be choosable while creatine network offerings",
+ "name": "canchooseservicecapability",
+ "type": "boolean"
}
],
"type": "list"
@@ -42682,8 +43072,83 @@
"type": "list"
},
{
- "description": "true if users from subdomains can access the domain level network",
- "name": "subdomainaccess",
+ "description": "the owner of the network",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the domain name of the network owner",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the network's gateway",
+ "name": "gateway",
+ "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": "VPC the network belongs to",
+ "name": "vpcid",
+ "type": "string"
+ },
+ {
+ "description": "list networks available for vm deployment",
+ "name": "canusefordeploy",
+ "type": "boolean"
+ },
+ {
+ "description": "the project id of the ipaddress",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "list networks that are persistent",
+ "name": "ispersistent",
+ "type": "boolean"
+ },
+ {
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "description": "the traffic type of the network",
+ "name": "traffictype",
+ "type": "string"
+ },
+ {
+ "description": "ACL Id associated with the VPC network",
+ "name": "aclid",
+ "type": "string"
+ },
+ {
+ "description": "The external id of the network",
+ "name": "externalid",
+ "type": "string"
+ },
+ {
+ "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes",
+ "name": "reservediprange",
+ "type": "string"
+ },
+ {
+ "description": "the total number of network traffic bytes received",
+ "name": "receivedbytes",
+ "type": "long"
+ },
+ {
+ "description": "true if network is system, false otherwise",
+ "name": "issystem",
"type": "boolean"
},
{
@@ -42692,38 +43157,13 @@
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "broadcast uri of the network. This parameter is visible to ROOT admins only",
- "name": "broadcasturi",
+ "description": "Name of the VPC to which this network belongs",
+ "name": "vpcname",
"type": "string"
},
{
- "description": "the first DNS for the network",
- "name": "dns1",
- "type": "string"
- },
- {
- "description": "true if network can span multiple zones",
- "name": "strechedl2subnet",
- "type": "boolean"
- },
- {
- "description": "name of the network offering the network is created from",
- "name": "networkofferingname",
- "type": "string"
- },
- {
- "description": "true if network offering is ip conserve mode enabled",
- "name": "networkofferingconservemode",
- "type": "boolean"
- },
- {
- "description": "The vlan of the network. This parameter is visible to ROOT admins only",
- "name": "vlan",
+ "description": "state of the network",
+ "name": "state",
"type": "string"
},
{
@@ -42732,8 +43172,23 @@
"type": "map"
},
{
- "description": "the physical network id",
- "name": "physicalnetworkid",
+ "description": "display text of the network offering the network is created from",
+ "name": "networkofferingdisplaytext",
+ "type": "string"
+ },
+ {
+ "description": "an optional field, whether to the display the network to the end user or not.",
+ "name": "displaynetwork",
+ "type": "boolean"
+ },
+ {
+ "description": "the second DNS for the network",
+ "name": "dns2",
+ "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"
},
{
@@ -42742,18 +43197,8 @@
"type": "boolean"
},
{
- "description": "the domain name of the network owner",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "true network requires restart",
- "name": "restartrequired",
- "type": "boolean"
- },
- {
- "description": "the traffic type of the network",
- "name": "traffictype",
+ "description": "availability of the network offering the network is created from",
+ "name": "networkofferingavailability",
"type": "string"
},
{
@@ -42762,31 +43207,131 @@
"type": "string"
},
{
- "description": "the date this network was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
- },
- {},
- {},
- {
- "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE",
- "name": "networkcidr",
+ "description": "The vlan of the network. This parameter is visible to ROOT admins only",
+ "name": "vlan",
"type": "string"
},
{
- "description": "the second DNS for the network",
- "name": "dns2",
+ "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans",
+ "name": "zonesnetworkspans",
+ "type": "set"
+ },
+ {
+ "description": "the list of resource tags associated with network",
+ "name": "tags",
+ "response": [
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ }
+ ],
+ "type": "list"
+ },
+ {
+ "description": "the name of the zone the network belongs to",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "true if network offering is ip conserve mode enabled",
+ "name": "networkofferingconservemode",
+ "type": "boolean"
+ },
+ {
+ "description": "name of the network offering the network is created from",
+ "name": "networkofferingname",
+ "type": "string"
+ },
+ {
+ "description": "the network's netmask",
+ "name": "netmask",
"type": "string"
},
{
"description": "the type of the network",
"name": "type",
"type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "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": "the displaytext of the network",
+ "name": "displaytext",
+ "type": "string"
+ },
+ {
+ "description": "the id of the network",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "network offering id the network is created from",
+ "name": "networkofferingid",
+ "type": "string"
+ },
+ {
+ "description": "the domain id of the network owner",
+ "name": "domainid",
+ "type": "string"
}
]
},
@@ -42804,27 +43349,12 @@
"type": "uuid"
},
{
- "description": "list of new network ids in which the moved VM will participate. In case no network ids are provided the VM will be part of the default network for that zone. In case there is no network yet created for the new account the default network will be created.",
+ "description": "domain id of the new VM owner.",
"length": 255,
- "name": "networkids",
- "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks",
+ "name": "domainid",
+ "related": "listDomainChildren,listDomains,listDomains",
"required": false,
- "type": "list"
- },
- {
- "description": "list of security group ids to be applied on the virtual machine. In case no security groups are provided the VM is part of the default security group.",
- "length": 255,
- "name": "securitygroupids",
- "related": "createSecurityGroup",
- "required": false,
- "type": "list"
- },
- {
- "description": "account name of the new VM owner.",
- "length": 255,
- "name": "account",
- "required": false,
- "type": "string"
+ "type": "uuid"
},
{
"description": "an optional project for the new VM owner.",
@@ -42835,27 +43365,178 @@
"type": "uuid"
},
{
- "description": "domain id of the new VM owner.",
+ "description": "account name of the new VM owner.",
"length": 255,
- "name": "domainid",
- "related": "listDomainChildren,listDomains,listDomains",
+ "name": "account",
"required": false,
- "type": "uuid"
+ "type": "string"
+ },
+ {
+ "description": "list of security group ids to be applied on the virtual machine. In case no security groups are provided the VM is part of the default security group.",
+ "length": 255,
+ "name": "securitygroupids",
+ "related": "createSecurityGroup",
+ "required": false,
+ "type": "list"
+ },
+ {
+ "description": "list of new network ids in which the moved VM will participate. In case no network ids are provided the VM will be part of the default network for that zone. In case there is no network yet created for the new account the default network will be created.",
+ "length": 255,
+ "name": "networkids",
+ "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks",
+ "required": false,
+ "type": "list"
}
],
"related": "migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance",
"response": [
{
+ "description": "State of the Service from LB rule",
+ "name": "servicestate",
+ "type": "string"
+ },
+ {
+ "description": "user generated name. The name of the virtual machine is returned if no displayname exists.",
+ "name": "displayname",
+ "type": "string"
+ },
+ {
+ "description": "the date when this virtual machine was updated last time",
+ "name": "lastupdated",
+ "type": "date"
+ },
+ {},
+ {
+ "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.",
+ "name": "templateid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the service offering of the virtual machine",
+ "name": "serviceofferingname",
+ "type": "string"
+ },
+ {
+ "description": "the name of the disk offering of the virtual machine",
+ "name": "diskofferingname",
+ "type": "string"
+ },
+ {
+ "description": " an alternate display text of the template for the virtual machine",
+ "name": "templatedisplaytext",
+ "type": "string"
+ },
+ {
+ "description": "the outgoing network traffic on the host",
+ "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": "the memory allocated for the virtual machine",
+ "name": "memory",
+ "type": "integer"
+ },
+ {
+ "description": "the password (if exists) of the virtual machine",
+ "name": "password",
+ "type": "string"
+ },
+ {
+ "description": "Guest vm Boot Type",
+ "name": "boottype",
+ "type": "string"
+ },
+ {
"description": "an alternate display text of the ISO attached to the virtual machine",
"name": "isodisplaytext",
"type": "string"
},
{
- "description": "the password (if exists) of the virtual machine",
- "name": "password",
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "description": "the ID of the domain in which the virtual machine exists",
+ "name": "domainid",
"type": "string"
},
{
+ "description": "device type of the root volume",
+ "name": "rootdevicetype",
+ "type": "string"
+ },
+ {
+ "description": "the target memory in vm",
+ "name": "memorytargetkbs",
+ "type": "long"
+ },
+ {
+ "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 internal memory that's free in vm or zero if it can not be calculated",
+ "name": "memoryintfreekbs",
+ "type": "long"
+ },
+ {
+ "description": "the name of the template for the virtual machine",
+ "name": "templatename",
+ "type": "string"
+ },
+ {
+ "description": "OS name of the vm",
+ "name": "osdisplayname",
+ "type": "string"
+ },
+ {
+ "description": "the memory used by the vm",
+ "name": "memorykbs",
+ "type": "long"
+ },
+ {
+ "description": "true if high-availability is enabled, false otherwise",
+ "name": "haenable",
+ "type": "boolean"
+ },
+ {
+ "description": "the speed of each cpu",
+ "name": "cpuspeed",
+ "type": "integer"
+ },
+ {
+ "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 name of the backup offering of the virtual machine",
+ "name": "backupofferingname",
+ "type": "string"
+ },
+ {
+ "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.",
+ "name": "isdynamicallyscalable",
+ "type": "boolean"
+ },
+ {
"description": "the account associated with the virtual machine",
"name": "account",
"type": "string"
@@ -42865,8 +43546,8 @@
"name": "affinitygroup",
"response": [
{
- "description": "the ID of the affinity group",
- "name": "id",
+ "description": "the domain name of the affinity group",
+ "name": "domain",
"type": "string"
},
{
@@ -42875,18 +43556,23 @@
"type": "string"
},
{
- "description": "virtual machine IDs associated with this affinity group",
- "name": "virtualmachineIds",
- "type": "list"
- },
- {
- "description": "the domain name of the affinity group",
- "name": "domain",
+ "description": "the account owning the affinity group",
+ "name": "account",
"type": "string"
},
{
- "description": "the project ID of the affinity group",
- "name": "projectid",
+ "description": "the type of the affinity group",
+ "name": "type",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the affinity group",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the description of the affinity group",
+ "name": "description",
"type": "string"
},
{
@@ -42900,71 +43586,607 @@
"type": "string"
},
{
- "description": "the type of the affinity group",
- "name": "type",
+ "description": "the project ID of the affinity group",
+ "name": "projectid",
"type": "string"
},
{
- "description": "the account owning the affinity group",
+ "description": "virtual machine IDs associated with this affinity group",
+ "name": "virtualmachineIds",
+ "type": "list"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the ID of the virtual machine",
+ "name": "id",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the group ID of the virtual machine",
+ "name": "groupid",
+ "type": "string"
+ },
+ {
+ "description": "the user's name who deployed the virtual machine",
+ "name": "username",
+ "type": "string"
+ },
+ {
+ "description": "the name of the ISO attached to the virtual machine",
+ "name": "isoname",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the project id of the vm",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the list of resource tags associated",
+ "name": "tags",
+ "response": [
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "the 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 account associated with the tag",
"name": "account",
"type": "string"
},
{
- "description": "the description of the affinity group",
- "name": "description",
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
"type": "string"
}
],
"type": "set"
},
{
+ "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 group name of the virtual machine",
+ "name": "group",
+ "type": "string"
+ },
+ {
+ "description": "Guest vm Boot Mode",
+ "name": "bootmode",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the host for the virtual machine",
+ "name": "hostid",
+ "type": "string"
+ },
+ {
+ "description": "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": "the vgpu type used by the virtual machine",
+ "name": "vgpu",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the availablility zone for the virtual machine",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "list of security groups associated with the virtual machine",
+ "name": "securitygroup",
+ "response": [
+ {
+ "description": "the list of ingress rules associated with the security group",
+ "name": "ingressrule",
+ "response": [
+ {
+ "description": "the code for the ICMP message response",
+ "name": "icmpcode",
+ "type": "integer"
+ },
+ {
+ "description": "security group name",
+ "name": "securitygroupname",
+ "type": "string"
+ },
+ {
+ "description": "the id of the security group rule",
+ "name": "ruleid",
+ "type": "string"
+ },
+ {
+ "description": "the CIDR notation for the base IP address of the security group rule",
+ "name": "cidr",
+ "type": "string"
+ },
+ {
+ "description": "the ending IP of the security group rule ",
+ "name": "endport",
+ "type": "integer"
+ },
+ {
+ "description": "account owning the security group rule",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the 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 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": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the list of egress rules associated with the security group",
+ "name": "egressrule",
+ "response": [
+ {
+ "description": "the starting IP of the security group rule",
+ "name": "startport",
+ "type": "integer"
+ },
+ {
+ "description": "the code for the ICMP message response",
+ "name": "icmpcode",
+ "type": "integer"
+ },
+ {
+ "description": "the CIDR notation for the base IP address of the security group rule",
+ "name": "cidr",
+ "type": "string"
+ },
+ {
+ "description": "the list of resource tags associated with the rule",
+ "name": "tags",
+ "response": [
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "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": "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": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "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 type of the ICMP message response",
+ "name": "icmptype",
+ "type": "integer"
+ },
+ {
+ "description": "the ending IP of the security group rule ",
+ "name": "endport",
+ "type": "integer"
+ },
+ {
+ "description": "security group name",
+ "name": "securitygroupname",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the description of the security group",
+ "name": "description",
+ "type": "string"
+ },
+ {
+ "description": "the domain name of the security group",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the security group",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the project id of the group",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the 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 account owning the security group",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the group",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the number of virtualmachines associated with this securitygroup",
+ "name": "virtualmachinecount",
+ "type": "integer"
+ },
+ {
+ "description": "the list of resource tags associated with the rule",
+ "name": "tags",
+ "response": [
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "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"
+ },
+ {
+ "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 write (io) of disk on the vm",
+ "name": "diskiowrite",
+ "type": "long"
+ },
+ {
+ "description": "the name of the domain in which the virtual machine exists",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the total number of network traffic bytes sent",
+ "name": "sentbytes",
+ "type": "long"
+ },
+ {},
+ {
+ "description": "OS type id of the vm",
+ "name": "ostypeid",
+ "type": "string"
+ },
+ {
+ "description": "true if the password rest feature is enabled, false otherwise",
+ "name": "passwordenabled",
+ "type": "boolean"
+ },
+ {
+ "description": "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 read (io) of disk on the vm",
+ "name": "diskioread",
+ "type": "long"
+ },
+ {
+ "description": "the incoming network traffic on the vm",
+ "name": "networkkbsread",
+ "type": "long"
+ },
+ {
+ "description": "public IP address id associated with vm via Static nat rule",
+ "name": "publicip",
+ "type": "string"
+ },
+ {
+ "description": "the write (bytes) of disk on the vm",
+ "name": "diskkbswrite",
+ "type": "long"
+ },
+ {
+ "description": "List of read-only Vm details as comma separated string.",
+ "name": "readonlydetails",
+ "type": "string"
+ },
+ {
+ "description": "the state of the virtual machine",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "ssh key-pair",
+ "name": "keypair",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the vm",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the vm's CPU currently used",
+ "name": "cpuused",
+ "type": "string"
+ },
+ {
+ "description": "device ID of the root volume",
+ "name": "rootdeviceid",
+ "type": "long"
+ },
+ {
"description": "the ID of the disk offering of the virtual machine",
"name": "diskofferingid",
"type": "string"
},
{
- "description": "the ID of the domain in which the virtual machine exists",
- "name": "domainid",
- "type": "string"
+ "description": "the virtual network for the service offering",
+ "name": "forvirtualnetwork",
+ "type": "boolean"
+ },
+ {
+ "description": "the read (bytes) of disk on the vm",
+ "name": "diskkbsread",
+ "type": "long"
},
{
"description": "the list of nics associated with vm",
"name": "nic",
"response": [
{
- "description": "the ID of the nic",
- "name": "id",
+ "description": "the Secondary ipv4 addr of nic",
+ "name": "secondaryip",
+ "type": "list"
+ },
+ {
+ "description": "the type of the nic",
+ "name": "type",
"type": "string"
},
{
- "description": "device id for the network when plugged into the virtual machine",
- "name": "deviceid",
- "type": "string"
+ "description": "ID of the VLAN/VNI if available",
+ "name": "vlanid",
+ "type": "integer"
},
{
- "description": "the ID of the corresponding network",
- "name": "networkid",
- "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 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": "the extra dhcp options on the nic",
@@ -42977,9 +44199,9 @@
"type": "string"
},
{
- "description": "ID of the VLAN/VNI if available",
- "name": "vlanid",
- "type": "integer"
+ "description": "true if nic is default, false otherwise",
+ "name": "macaddress",
+ "type": "string"
},
{
"description": "the name of the corresponding network",
@@ -42987,19 +44209,29 @@
"type": "string"
},
{
- "description": "the Secondary ipv4 addr of nic",
- "name": "secondaryip",
- "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 gateway of the nic",
+ "name": "gateway",
+ "type": "string"
+ },
+ {
+ "description": "the traffic type of the nic",
+ "name": "traffictype",
+ "type": "string"
+ },
+ {
+ "description": "the cidr of IPv6 network",
+ "name": "ip6cidr",
+ "type": "string"
+ },
+ {
+ "description": "device id for the network when plugged into the virtual machine",
+ "name": "deviceid",
+ "type": "string"
},
{
"description": "the IPv6 address of network",
@@ -43007,23 +44239,8 @@
"type": "string"
},
{
- "description": "Id of the NSX Logical Switch (if NSX based), null otherwise",
- "name": "nsxlogicalswitch",
- "type": "string"
- },
- {
- "description": "the ip address of the nic",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "description": "the isolated private VLAN if available",
- "name": "isolatedpvlan",
- "type": "integer"
- },
- {
- "description": "true if nic is default, false otherwise",
- "name": "macaddress",
+ "description": "Id of the vm to which the nic belongs",
+ "name": "virtualmachineid",
"type": "string"
},
{
@@ -43042,759 +44259,87 @@
"type": "string"
},
{
- "description": "the gateway of the nic",
- "name": "gateway",
+ "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 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 isolated private VLAN if available",
+ "name": "isolatedpvlan",
+ "type": "integer"
+ },
+ {
+ "description": "the ID of the corresponding network",
+ "name": "networkid",
+ "type": "string"
+ },
+ {
+ "description": "the ip address of the nic",
+ "name": "ipaddress",
"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": "Id of the vm to which the nic belongs",
- "name": "virtualmachineid",
- "type": "string"
}
],
"type": "set"
},
{
- "description": "the pool type of the virtual machine",
- "name": "pooltype",
- "type": "string"
- },
- {
- "description": "the ID of the virtual machine",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the 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",
- "type": "string"
- },
- {
- "description": "the date when this virtual machine was updated last time",
- "name": "lastupdated",
- "type": "date"
- },
- {
- "description": "the target memory in vm",
- "name": "memorytargetkbs",
- "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": "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 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": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "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 account associated with the tag",
- "name": "account",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {},
- {
- "description": "device type of the root volume",
- "name": "rootdevicetype",
- "type": "string"
- },
- {
- "description": "the group name of the virtual machine",
- "name": "group",
- "type": "string"
- },
- {
"description": "the hypervisor on which the template runs",
"name": "hypervisor",
"type": "string"
},
{
- "description": "true if the password rest feature is enabled, false otherwise",
- "name": "passwordenabled",
- "type": "boolean"
- },
- {
- "description": "the project name of the vm",
- "name": "project",
- "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": "the name of the backup offering of the virtual machine",
- "name": "backupofferingname",
- "type": "string"
- },
- {
- "description": "instance name of the user vm; this parameter is returned to the ROOT admin only",
- "name": "instancename",
- "type": "string"
- },
- {
- "description": "Vm details in key/value pairs.",
- "name": "details",
- "type": "map"
- },
- {},
- {
- "description": "the total number of network traffic bytes received",
- "name": "receivedbytes",
- "type": "long"
- },
- {
- "description": "the name of the disk offering of the virtual machine",
- "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 name of the ISO attached to the virtual machine",
- "name": "isoname",
- "type": "string"
- },
- {
- "description": "public IP address id associated with vm via Static nat rule",
- "name": "publicip",
- "type": "string"
- },
- {
"description": "the ID of the service offering of the virtual machine",
"name": "serviceofferingid",
"type": "string"
},
{
- "description": "State of the Service from LB rule",
- "name": "servicestate",
- "type": "string"
- },
- {
- "description": "OS type id of the vm",
- "name": "ostypeid",
- "type": "string"
- },
- {
- "description": "the read (bytes) of disk on the vm",
- "name": "diskkbsread",
- "type": "long"
- },
- {
- "description": "an optional field whether to the display the vm to the end user or not.",
- "name": "displayvm",
- "type": "boolean"
- },
- {
- "description": "the write (io) of disk on the vm",
- "name": "diskiowrite",
- "type": "long"
- },
- {
- "description": "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": "the total number of network traffic bytes sent",
- "name": "sentbytes",
- "type": "long"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "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 name of the security group",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the project name of the group",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the domain ID of the security group",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the 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": "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": "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 id of the security group rule",
- "name": "ruleid",
- "type": "string"
- },
- {
- "description": "the protocol of the security group rule",
- "name": "protocol",
- "type": "string"
- },
- {
- "description": "the list of resource tags associated with the rule",
- "name": "tags",
- "response": [
- {
- "description": "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"
- },
- {
- "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": "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"
- }
- ],
- "type": "set"
- },
- {
- "description": "the starting IP of the security group rule",
- "name": "startport",
- "type": "integer"
- },
- {
- "description": "the code for the ICMP message response",
- "name": "icmpcode",
- "type": "integer"
- }
- ],
- "type": "set"
- },
- {
- "description": "the account owning the security group",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the project id of the group",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the list of egress rules associated with the security group",
- "name": "egressrule",
- "response": [
- {
- "description": "the protocol of the security group rule",
- "name": "protocol",
- "type": "string"
- },
- {
- "description": "security group name",
- "name": "securitygroupname",
- "type": "string"
- },
- {
- "description": "the starting IP of the security group rule",
- "name": "startport",
- "type": "integer"
- },
- {
- "description": "the 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 id of the security group rule",
- "name": "ruleid",
- "type": "string"
- },
- {
- "description": "the CIDR notation for the base IP address of the security group rule",
- "name": "cidr",
- "type": "string"
- },
- {
- "description": "the list of resource tags associated with the rule",
- "name": "tags",
- "response": [
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the 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 project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the code for the ICMP message response",
- "name": "icmpcode",
- "type": "integer"
- }
- ],
- "type": "set"
- },
- {
- "description": "the list of resource tags associated with the rule",
- "name": "tags",
- "response": [
- {
- "description": "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": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- }
- ],
- "type": "set"
- }
- ],
- "type": "set"
- },
- {
- "description": "Guest vm Boot Type",
- "name": "boottype",
- "type": "string"
- },
- {
- "description": "the ID of the availablility zone for the virtual machine",
- "name": "zoneid",
- "type": "string"
- },
- {
"description": "the number of cpu this virtual machine is running with",
"name": "cpunumber",
"type": "integer"
},
{
- "description": "List of read-only Vm details as comma separated string.",
- "name": "readonlydetails",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
- "description": "the date when this virtual machine was created",
- "name": "created",
- "type": "date"
+ "description": "Vm details in key/value pairs.",
+ "name": "details",
+ "type": "map"
},
{
- "description": "the ID of 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"
},
{
- "description": "the name of the domain in which the virtual machine exists",
- "name": "domain",
+ "description": "the user's ID who deployed the virtual machine",
+ "name": "userid",
"type": "string"
- },
- {
- "description": "ssh key-pair",
- "name": "keypair",
- "type": "string"
- },
- {
- "description": "the ID of the ISO attached to the virtual machine",
- "name": "isoid",
- "type": "string"
- },
- {
- "description": "the name of the availability zone for the virtual machine",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "the name of the template for the virtual machine",
- "name": "templatename",
- "type": "string"
- },
- {
- "description": "the outgoing network traffic on the host",
- "name": "networkkbswrite",
- "type": "long"
- },
- {
- "description": "the internal memory that's free in vm or zero if it can not be calculated",
- "name": "memoryintfreekbs",
- "type": "long"
- },
- {
- "description": "OS name of the vm",
- "name": "osdisplayname",
- "type": "string"
- },
- {
- "description": "Guest vm Boot Mode",
- "name": "bootmode",
- "type": "string"
- },
- {
- "description": "the read (io) of disk on the vm",
- "name": "diskioread",
- "type": "long"
- },
- {
- "description": "the speed of each cpu",
- "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": "Os type ID of the virtual machine",
- "name": "guestosid",
- "type": "string"
- },
- {
- "description": " an alternate display text of the template for the virtual machine",
- "name": "templatedisplaytext",
- "type": "string"
- },
- {
- "description": "the name of the virtual machine",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the vgpu type used by the virtual machine",
- "name": "vgpu",
- "type": "string"
- },
- {
- "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 state of the virtual machine",
- "name": "state",
- "type": "string"
- },
- {
- "description": "the incoming network traffic on the vm",
- "name": "networkkbsread",
- "type": "long"
- },
- {
- "description": "the memory used by the vm",
- "name": "memorykbs",
- "type": "long"
- },
- {
- "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 project id of the vm",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "the ID of the backup offering of the virtual machine",
- "name": "backupofferingid",
- "type": "string"
- },
- {
- "description": "the write (bytes) of disk on the vm",
- "name": "diskkbswrite",
- "type": "long"
}
],
"since": "3.0.0"
@@ -43815,22 +44360,22 @@
],
"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",
@@ -43845,6 +44390,13 @@
"name": "configureNetscalerLoadBalancer",
"params": [
{
+ "description": "true if this netscaler device to dedicated for a account, false if the netscaler device will be shared by multiple accounts",
+ "length": 255,
+ "name": "lbdevicededicated",
+ "required": false,
+ "type": "boolean"
+ },
+ {
"description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.",
"length": 255,
"name": "podids",
@@ -43853,13 +44405,6 @@
"type": "list"
},
{
- "description": "true if this netscaler device to dedicated for a account, false if the netscaler device will be shared by multiple accounts",
- "length": 255,
- "name": "lbdevicededicated",
- "required": false,
- "type": "boolean"
- },
- {
"description": "capacity of the device, Capacity will be interpreted as number of networks device can handle",
"length": 255,
"name": "lbdevicecapacity",
@@ -43885,14 +44430,13 @@
"related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter,deployNetscalerVpx",
"response": [
{
- "description": "device capacity",
- "name": "lbdevicecapacity",
- "type": "long"
+ "description": "device name",
+ "name": "lbdevicename",
+ "type": "string"
},
- {},
{
- "description": "device id of the netscaler load balancer",
- "name": "lbdeviceid",
+ "description": "the private interface of the load balancer",
+ "name": "privateinterface",
"type": "string"
},
{
@@ -43901,45 +44445,9 @@
"type": "string"
},
{
- "description": "true if device is dedicated for an account",
- "name": "lbdevicededicated",
- "type": "boolean"
- },
- {
- "description": "private IP of the NetScaler representing GSLB site",
- "name": "gslbproviderprivateip",
- "type": "string"
- },
- {
- "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider",
- "name": "isexclusivegslbprovider",
- "type": "boolean"
- },
- {},
- {
- "description": "name of the provider",
- "name": "provider",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "device name",
- "name": "lbdevicename",
- "type": "string"
- },
- {
- "description": "the management IP address of the external load balancer",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.",
- "name": "podids",
- "type": "list"
+ "description": "device capacity",
+ "name": "lbdevicecapacity",
+ "type": "long"
},
{
"description": "the public interface of the load balancer",
@@ -43947,11 +44455,6 @@
"type": "string"
},
{
- "description": "public IP of the NetScaler representing GSLB site",
- "name": "gslbproviderpublicip",
- "type": "string"
- },
- {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
@@ -43962,14 +44465,56 @@
"type": "boolean"
},
{
- "description": "the private interface of the load balancer",
- "name": "privateinterface",
+ "description": "device id of the netscaler load balancer",
+ "name": "lbdeviceid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider",
+ "name": "isexclusivegslbprovider",
+ "type": "boolean"
+ },
+ {
+ "description": "the 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": "true if device is dedicated for an account",
+ "name": "lbdevicededicated",
+ "type": "boolean"
+ },
+ {
+ "description": "name of the provider",
+ "name": "provider",
+ "type": "string"
+ },
+ {
+ "description": "private IP of the NetScaler representing GSLB site",
+ "name": "gslbproviderprivateip",
"type": "string"
},
{
"description": "device state",
"name": "lbdevicestate",
"type": "string"
+ },
+ {},
+ {
+ "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.",
+ "name": "podids",
+ "type": "list"
}
]
},
@@ -43979,6 +44524,14 @@
"name": "listOvsElements",
"params": [
{
+ "description": "list ovs elements by id",
+ "length": 255,
+ "name": "id",
+ "related": "listOvsElements,configureOvsElement",
+ "required": false,
+ "type": "uuid"
+ },
+ {
"description": "",
"length": 255,
"name": "pagesize",
@@ -43986,17 +44539,10 @@
"type": "integer"
},
{
- "description": "list network offerings by enabled state",
+ "description": "list ovs elements by network service provider id",
"length": 255,
- "name": "enabled",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "list ovs elements by id",
- "length": 255,
- "name": "id",
- "related": "listOvsElements,configureOvsElement",
+ "name": "nspid",
+ "related": "listNetworkServiceProviders,listTrafficTypes",
"required": false,
"type": "uuid"
},
@@ -44015,36 +44561,18 @@
"type": "string"
},
{
- "description": "list ovs elements by network service provider id",
+ "description": "list network offerings by enabled state",
"length": 255,
- "name": "nspid",
- "related": "listNetworkServiceProviders,listTrafficTypes",
+ "name": "enabled",
"required": false,
- "type": "uuid"
+ "type": "boolean"
}
],
"related": "configureOvsElement",
"response": [
{
- "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",
- "type": "string"
- },
- {},
- {},
- {
- "description": "the project id of the ipaddress",
- "name": "projectid",
- "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"
},
{
@@ -44053,8 +44581,24 @@
"type": "string"
},
{
- "description": "the physical network service provider id of the provider",
- "name": "nspid",
+ "description": "Enabled/Disabled the service provider",
+ "name": "enabled",
+ "type": "boolean"
+ },
+ {
+ "description": "the account associated with the provider",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the address",
+ "name": "project",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the domain ID associated with the provider",
+ "name": "domainid",
"type": "string"
},
{
@@ -44063,18 +44607,19 @@
"type": "integer"
},
{
- "description": "Enabled/Disabled the service provider",
- "name": "enabled",
- "type": "boolean"
+ "description": "the domain associated with the provider",
+ "name": "domain",
+ "type": "string"
},
+ {},
{
- "description": "the project name of the address",
- "name": "project",
+ "description": "the project id of the ipaddress",
+ "name": "projectid",
"type": "string"
},
{
- "description": "the domain associated with the provider",
- "name": "domain",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
}
]
@@ -44085,6 +44630,13 @@
"name": "associateUcsProfileToBlade",
"params": [
{
+ "description": "profile dn",
+ "length": 255,
+ "name": "profiledn",
+ "required": true,
+ "type": "string"
+ },
+ {
"description": "ucs manager id",
"length": 255,
"name": "ucsmanagerid",
@@ -44099,13 +44651,6 @@
"related": "associateUcsProfileToBlade",
"required": true,
"type": "uuid"
- },
- {
- "description": "profile dn",
- "length": 255,
- "name": "profiledn",
- "required": true,
- "type": "string"
}
],
"related": "",
@@ -44116,9 +44661,9 @@
"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",
+ "type": "string"
},
{
"description": "ucs manager id",
@@ -44126,27 +44671,27 @@
"type": "string"
},
{
+ "description": "ucs blade dn",
+ "name": "bladedn",
+ "type": "string"
+ },
+ {},
+ {},
+ {
+ "description": "ucs blade id",
+ "name": "id",
+ "type": "string"
+ },
+ {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
{
- "description": "ucs blade dn",
- "name": "bladedn",
- "type": "string"
- },
- {
- "description": "ucs blade id",
- "name": "id",
- "type": "string"
- },
- {
- "description": "associated ucs profile dn",
- "name": "profiledn",
- "type": "string"
- },
- {},
- {}
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ }
]
},
{
@@ -44173,27 +44718,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": "the 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.15.0"
},
@@ -44210,27 +44755,6 @@
"type": "boolean"
},
{
- "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": "VMware datacenter name.",
- "length": 255,
- "name": "name",
- "required": false,
- "type": "string"
- },
- {
- "description": "The username required to connect to resource.",
- "length": 255,
- "name": "username",
- "required": false,
- "type": "string"
- },
- {
"description": "The password for specified username.",
"length": 255,
"name": "password",
@@ -44244,11 +44768,38 @@
"related": "createZone,updateZone,listZones,listZones",
"required": true,
"type": "uuid"
+ },
+ {
+ "description": "VMware datacenter name.",
+ "length": 255,
+ "name": "name",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "The name/IP of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.",
+ "length": 255,
+ "name": "vcenter",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "The username required to connect to resource.",
+ "length": 255,
+ "name": "username",
+ "required": false,
+ "type": "string"
}
],
"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"
@@ -44269,16 +44820,10 @@
"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 associated with this VMware Datacenter",
- "name": "zoneid",
- "type": "long"
}
],
"since": "4.12.0"
@@ -44306,28 +44851,28 @@
],
"related": "",
"response": [
- {
- "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",
+ "description": "the id of the router",
+ "name": "routerid",
"type": "string"
},
+ {},
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
- {},
- {}
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ }
],
"since": "4.14.0"
},
@@ -44339,6 +44884,13 @@
{
"description": "",
"length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "",
+ "length": 255,
"name": "page",
"required": false,
"type": "integer"
@@ -44349,53 +44901,46 @@
"name": "keyword",
"required": false,
"type": "string"
- },
- {
- "description": "",
- "length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
}
],
"related": "",
"response": [
{
- "description": "username",
- "name": "username",
- "type": "string"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
- {},
- {},
- {
- "description": "num_retries",
- "name": "numretries",
- "type": "string"
- },
- {
- "description": "id",
- "name": "id",
- "type": "string"
- },
{
"description": "uuid",
"name": "uuid",
"type": "string"
},
+ {},
+ {},
+ {
+ "description": "username",
+ "name": "username",
+ "type": "string"
+ },
{
"description": "ncc_ip",
"name": "ipaddress",
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "id",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "num_retries",
+ "name": "numretries",
+ "type": "string"
}
]
},
@@ -44405,20 +44950,6 @@
"name": "resizeVolume",
"params": [
{
- "description": "New volume size in GB",
- "length": 255,
- "name": "size",
- "required": false,
- "type": "long"
- },
- {
- "description": "New maximum number of IOPS",
- "length": 255,
- "name": "maxiops",
- "required": false,
- "type": "long"
- },
- {
"description": "Verify OK to Shrink",
"length": 255,
"name": "shrinkok",
@@ -44426,14 +44957,6 @@
"type": "boolean"
},
{
- "description": "the ID of the disk volume",
- "length": 255,
- "name": "id",
- "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume",
- "required": true,
- "type": "uuid"
- },
- {
"description": "New minimum number of IOPS",
"length": 255,
"name": "miniops",
@@ -44441,43 +44964,136 @@
"type": "long"
},
{
+ "description": "New volume size in GB",
+ "length": 255,
+ "name": "size",
+ "required": false,
+ "type": "long"
+ },
+ {
"description": "new disk offering id",
"length": 255,
"name": "diskofferingid",
"related": "createDiskOffering,listDiskOfferings",
"required": false,
"type": "uuid"
+ },
+ {
+ "description": "the ID of the disk volume",
+ "length": 255,
+ "name": "id",
+ "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume",
+ "required": true,
+ "type": "uuid"
+ },
+ {
+ "description": "New maximum number of IOPS",
+ "length": 255,
+ "name": "maxiops",
+ "required": false,
+ "type": "long"
}
],
"related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume",
"response": [
{
- "description": "the date the disk volume was created",
- "name": "created",
- "type": "date"
+ "description": "the project id of the vpn",
+ "name": "projectid",
+ "type": "string"
},
{
- "description": "the bytes actually consumed on disk",
- "name": "virtualsize",
+ "description": "the read (bytes) of disk on the vm",
+ "name": "diskkbsread",
"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": "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",
+ "name": "snapshotid",
+ "type": "string"
+ },
+ {
+ "description": "provisioning type used to create volumes.",
+ "name": "provisioningtype",
+ "type": "string"
+ },
+ {
"description": "ID of the disk volume",
"name": "id",
"type": "string"
},
{
+ "description": "pod id of the volume",
+ "name": "podid",
+ "type": "string"
+ },
+ {
+ "description": "ID of the availability zone",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "cluster id of the volume",
+ "name": "clusterid",
+ "type": "string"
+ },
+ {
+ "description": "display name of the virtual machine",
+ "name": "vmdisplayname",
+ "type": "string"
+ },
+ {
+ "description": "the disk utilization",
+ "name": "utilization",
+ "type": "string"
+ },
+ {
+ "description": "bytes write rate of the disk volume",
+ "name": "diskBytesWriteRate",
+ "type": "long"
+ },
+ {
+ "description": "the bytes actually consumed on disk",
+ "name": "virtualsize",
+ "type": "long"
+ },
+ {
+ "description": "the date the disk volume was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "name of the availability zone",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "shared or local storage",
+ "name": "storagetype",
+ "type": "string"
+ },
+ {
"description": "the list of resource tags associated",
"name": "tags",
"response": [
{
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
+ "description": "tag value",
+ "name": "value",
"type": "string"
},
{
@@ -44486,28 +45102,8 @@
"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 ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
+ "description": "id of the resource",
+ "name": "resourceid",
"type": "string"
},
{
@@ -44516,16 +45112,41 @@
"type": "string"
},
{
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
"description": "the domain associated with the tag",
"name": "domain",
"type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
}
],
"type": "set"
},
{
- "description": "pod name of the volume",
- "name": "podname",
+ "description": "name of the disk offering",
+ "name": "diskofferingname",
"type": "string"
},
{
@@ -44534,11 +45155,130 @@
"type": "long"
},
{
- "description": "the chain info of the volume",
- "name": "chaininfo",
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "io requests write rate of the disk volume per the disk offering",
+ "name": "diskIopsWriteRate",
+ "type": "long"
+ },
+ {
+ "description": "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 ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.",
+ "name": "deviceid",
+ "type": "long"
+ },
+ {
+ "description": "the state of the disk volume",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the disk volume",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the disk volume",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the display text of the disk offering",
+ "name": "diskofferingdisplaytext",
+ "type": "string"
+ },
+ {
+ "description": "name of the service offering for root disk",
+ "name": "serviceofferingname",
+ "type": "string"
+ },
+ {
+ "description": "id of the primary storage hosting the disk volume; returned to admin user only",
+ "name": "storageid",
+ "type": "string"
+ },
+ {
+ "description": "name of the primary storage hosting the disk volume",
+ "name": "storage",
+ "type": "string"
+ },
+ {
+ "description": "the read (io) of disk on the vm",
+ "name": "diskioread",
+ "type": "long"
+ },
+ {
+ "description": "cluster name where the volume is allocated",
+ "name": "clustername",
+ "type": "string"
+ },
+ {
+ "description": "state of the virtual machine",
+ "name": "vmstate",
+ "type": "string"
+ },
+ {
+ "description": "pod name of the volume",
+ "name": "podname",
+ "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": "true if the volume is extractable, false otherwise",
+ "name": "isextractable",
+ "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": "name of the virtual machine",
+ "name": "vmname",
+ "type": "string"
+ },
+ {
+ "description": "the bytes allocated",
+ "name": "physicalsize",
+ "type": "long"
+ },
+ {
+ "description": "the name of the ISO attached to the virtual machine",
+ "name": "isoname",
+ "type": "string"
+ },
+ {
+ "description": "ID of the service offering for root disk",
+ "name": "serviceofferingid",
+ "type": "string"
+ },
+ {
+ "description": "Hypervisor the volume belongs to",
+ "name": "hypervisor",
+ "type": "string"
+ },
{
"description": "size of the disk volume",
"name": "size",
@@ -44549,270 +45289,25 @@
"name": "templatedisplaytext",
"type": "string"
},
- {},
- {
- "description": "the status of the volume",
- "name": "status",
- "type": "string"
- },
- {
- "description": "the write (bytes) of disk on the vm",
- "name": "diskkbswrite",
- "type": "long"
- },
- {
- "description": "the name of the template for the virtual machine",
- "name": "templatename",
- "type": "string"
- },
- {
- "description": "cluster name where the volume is allocated",
- "name": "clustername",
- "type": "string"
- },
- {
- "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": "id of the virtual machine",
- "name": "virtualmachineid",
- "type": "string"
- },
- {
- "description": "name of the virtual machine",
- "name": "vmname",
- "type": "string"
- },
- {
- "description": "name of the disk volume",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the ID of the ISO attached to the virtual machine",
- "name": "isoid",
- "type": "string"
- },
{
"description": "the display text of the service offering for root disk",
"name": "serviceofferingdisplaytext",
"type": "string"
},
{
- "description": "the bytes allocated",
- "name": "physicalsize",
- "type": "long"
- },
- {
- "description": "pod id of the volume",
- "name": "podid",
- "type": "string"
- },
- {
- "description": "true if the volume is extractable, false otherwise",
- "name": "isextractable",
- "type": "boolean"
- },
- {
- "description": "the state of the disk volume",
- "name": "state",
- "type": "string"
- },
- {
- "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.",
- "name": "templateid",
- "type": "string"
- },
- {
- "description": "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": "Hypervisor the volume belongs to",
- "name": "hypervisor",
- "type": "string"
- },
- {
- "description": "shared or local storage",
- "name": "storagetype",
- "type": "string"
- },
- {
- "description": "true if storage snapshot is supported for the volume, false otherwise",
- "name": "supportsstoragesnapshot",
- "type": "boolean"
- },
- {
- "description": "name of the service offering for root disk",
- "name": "serviceofferingname",
- "type": "string"
- },
- {
- "description": "need quiesce vm or not when taking snapshot",
- "name": "quiescevm",
- "type": "boolean"
- },
- {
- "description": "io requests write rate of the disk volume per the disk offering",
- "name": "diskIopsWriteRate",
- "type": "long"
- },
- {
- "description": "name of the availability zone",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.",
- "name": "deviceid",
- "type": "long"
- },
- {
- "description": "name of the disk offering",
- "name": "diskofferingname",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "state of the virtual machine",
- "name": "vmstate",
- "type": "string"
- },
- {
- "description": "the disk utilization",
- "name": "utilization",
- "type": "string"
- },
- {
- "description": "the project id of the vpn",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the path of the volume",
- "name": "path",
- "type": "string"
- },
- {
- "description": "ID of the service offering for root disk",
- "name": "serviceofferingid",
- "type": "string"
- },
- {
- "description": "type of the disk volume (ROOT or DATADISK)",
- "name": "type",
- "type": "string"
- },
- {
- "description": "bytes read rate of the disk volume",
- "name": "diskBytesReadRate",
- "type": "long"
- },
- {
- "description": "the project name of the vpn",
- "name": "project",
- "type": "string"
- },
- {
- "description": "ID of the snapshot from which this volume was created",
- "name": "snapshotid",
- "type": "string"
- },
- {
- "description": "the account associated with the disk volume",
- "name": "account",
- "type": "string"
- },
- {
- "description": "id of the primary storage hosting the disk volume; returned to admin user only",
- "name": "storageid",
- "type": "string"
- },
- {
- "description": "bytes write rate of the disk volume",
- "name": "diskBytesWriteRate",
- "type": "long"
- },
- {
- "description": "the domain associated with the disk volume",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the read (io) of disk on the vm",
- "name": "diskioread",
- "type": "long"
- },
- {
- "description": "provisioning type used to create volumes.",
- "name": "provisioningtype",
- "type": "string"
- },
- {
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "max iops of the disk volume",
- "name": "maxiops",
- "type": "long"
- },
- {
- "description": "cluster id of the volume",
- "name": "clusterid",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the disk volume",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "io requests read rate of the disk volume per the disk offering",
- "name": "diskIopsReadRate",
- "type": "long"
- },
- {
- "description": "the write (io) of disk on the vm",
- "name": "diskiowrite",
- "type": "long"
- },
- {
"description": "the date the volume was attached to a VM instance",
"name": "attached",
"type": "date"
},
+ {},
{
- "description": "ID of the disk offering",
- "name": "diskofferingid",
+ "description": "name of the disk volume",
+ "name": "name",
"type": "string"
},
{
- "description": "the read (bytes) of disk on the vm",
- "name": "diskkbsread",
- "type": "long"
- },
- {
- "description": "the display text of the disk offering",
- "name": "diskofferingdisplaytext",
+ "description": "ID of the disk offering",
+ "name": "diskofferingid",
"type": "string"
},
{
@@ -44821,18 +45316,68 @@
"type": "boolean"
},
{
- "description": "ID of the availability zone",
- "name": "zoneid",
+ "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": "max iops of the disk volume",
+ "name": "maxiops",
+ "type": "long"
+ },
+ {
+ "description": "the project name of the vpn",
+ "name": "project",
"type": "string"
},
{
- "description": "name of the primary storage hosting the disk volume",
- "name": "storage",
+ "description": "type of the disk volume (ROOT or DATADISK)",
+ "name": "type",
"type": "string"
},
{
- "description": "an alternate display text of the ISO attached to the virtual machine",
- "name": "isodisplaytext",
+ "description": "the write (bytes) of disk on the vm",
+ "name": "diskkbswrite",
+ "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",
+ "type": "string"
+ },
+ {
+ "description": "need quiesce vm or not when taking snapshot",
+ "name": "quiescevm",
+ "type": "boolean"
+ },
+ {
+ "description": "the account associated with the disk volume",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the chain info of the volume",
+ "name": "chaininfo",
+ "type": "string"
+ },
+ {
+ "description": "the path of the volume",
+ "name": "path",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the ISO attached to the virtual machine",
+ "name": "isoid",
"type": "string"
}
]
@@ -44843,6 +45388,13 @@
"name": "deleteAffinityGroup",
"params": [
{
+ "description": "the account of the affinity group. Must be specified with domain ID",
+ "length": 255,
+ "name": "account",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "The name of the affinity group. Mutually exclusive with ID parameter",
"length": 255,
"name": "name",
@@ -44858,52 +45410,45 @@
"type": "uuid"
},
{
- "description": "the project of the affinity group",
- "length": 255,
- "name": "projectid",
- "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "the account of the affinity group. Must be specified with domain ID",
- "length": 255,
- "name": "account",
- "required": false,
- "type": "string"
- },
- {
"description": "The ID of the affinity group. Mutually exclusive with name parameter",
"length": 255,
"name": "id",
"related": "",
"required": false,
"type": "uuid"
+ },
+ {
+ "description": "the project of the affinity group",
+ "length": 255,
+ "name": "projectid",
+ "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject",
+ "required": false,
+ "type": "uuid"
}
],
"response": [
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {},
- {},
- {
"description": "any text associated with the success or failure",
"name": "displaytext",
"type": "string"
},
{
+ "description": "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"
- }
+ },
+ {}
]
},
{
@@ -44921,28 +45466,28 @@
}
],
"response": [
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
+ {},
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
- {},
+ {
+ "description": "any text associated with the success or failure",
+ "name": "displaytext",
+ "type": "string"
+ },
{
"description": "true if operation is executed successfully",
"name": "success",
"type": "boolean"
},
- {},
{
- "description": "any text associated with the success or failure",
- "name": "displaytext",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
- }
+ },
+ {}
],
"since": "3.0.0"
},
@@ -44971,18 +45516,18 @@
"name": "displaytext",
"type": "string"
},
+ {},
+ {},
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
- {},
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
- },
- {}
+ }
],
"since": "3.0.0"
},
@@ -44992,6 +45537,13 @@
"name": "listNetworkDevice",
"params": [
{
+ "description": "Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall",
+ "length": 255,
+ "name": "networkdevicetype",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "",
"length": 255,
"name": "pagesize",
@@ -45006,13 +45558,6 @@
"type": "integer"
},
{
- "description": "parameters for network device",
- "length": 255,
- "name": "networkdeviceparameterlist",
- "required": false,
- "type": "map"
- },
- {
"description": "List by keyword",
"length": 255,
"name": "keyword",
@@ -45020,15 +45565,20 @@
"type": "string"
},
{
- "description": "Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall",
+ "description": "parameters for network device",
"length": 255,
- "name": "networkdevicetype",
+ "name": "networkdeviceparameterlist",
"required": false,
- "type": "string"
+ "type": "map"
}
],
"related": "addNetworkDevice",
"response": [
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
{},
{
"description": "the ID of the network device",
@@ -45037,11 +45587,6 @@
},
{},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
@@ -45054,6 +45599,13 @@
"name": "updateStorageNetworkIpRange",
"params": [
{
+ "description": "the ending IP address",
+ "length": 255,
+ "name": "endip",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "Optional. the vlan the ip range sits on",
"length": 255,
"name": "vlan",
@@ -45061,13 +45613,6 @@
"type": "integer"
},
{
- "description": "the beginning IP address",
- "length": 255,
- "name": "startip",
- "required": false,
- "type": "string"
- },
- {
"description": "UUID of storage network ip range",
"length": 255,
"name": "id",
@@ -45076,9 +45621,9 @@
"type": "uuid"
},
{
- "description": "the ending IP address",
+ "description": "the beginning IP address",
"length": 255,
- "name": "endip",
+ "name": "startip",
"required": false,
"type": "string"
},
@@ -45093,18 +45638,18 @@
"related": "createStorageNetworkIpRange,listStorageNetworkIpRange",
"response": [
{
- "description": "the Zone uuid of the storage network IP range",
- "name": "zoneid",
- "type": "string"
- },
- {
"description": "the start ip of the storage network IP range",
"name": "startip",
"type": "string"
},
{
- "description": "the uuid of storage network IP range.",
- "name": "id",
+ "description": "the Zone uuid of the storage network IP range",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
@@ -45112,16 +45657,8 @@
"name": "networkid",
"type": "string"
},
- {
- "description": "the Pod uuid for the storage network IP range",
- "name": "podid",
- "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",
@@ -45132,22 +45669,30 @@
"name": "endip",
"type": "string"
},
- {},
{
- "description": "the gateway of the storage network IP range",
- "name": "gateway",
+ "description": "the uuid of storage network IP range.",
+ "name": "id",
"type": "string"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the Pod uuid for the storage network IP range",
+ "name": "podid",
"type": "string"
},
- {},
{
"description": "the netmask of the storage network IP range",
"name": "netmask",
"type": "string"
+ },
+ {
+ "description": "the ID or VID of the VLAN.",
+ "name": "vlan",
+ "type": "integer"
+ },
+ {
+ "description": "the gateway of the storage network IP range",
+ "name": "gateway",
+ "type": "string"
}
],
"since": "3.0.0"
@@ -45188,23 +45733,7 @@
"name": "podid",
"type": "string"
},
- {
- "description": "the Name of the Pod",
- "name": "podname",
- "type": "string"
- },
{},
- {},
- {
- "description": "the Dedication Affinity Group ID of the pod",
- "name": "affinitygroupid",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
@@ -45220,10 +45749,26 @@
"name": "id",
"type": "string"
},
+ {},
+ {
+ "description": "the Name of the Pod",
+ "name": "podname",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
{
"description": "the domain ID to which the Pod is dedicated",
"name": "domainid",
"type": "string"
+ },
+ {
+ "description": "the Dedication Affinity Group ID of the pod",
+ "name": "affinitygroupid",
+ "type": "string"
}
]
},
@@ -45233,11 +45778,12 @@
"name": "listProjectRoles",
"params": [
{
- "description": "List project role by project role name.",
+ "description": "List project role by project ID.",
"length": 255,
- "name": "name",
- "required": false,
- "type": "string"
+ "name": "projectid",
+ "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject",
+ "required": true,
+ "type": "uuid"
},
{
"description": "List project role by project role ID.",
@@ -45248,25 +45794,28 @@
"type": "uuid"
},
{
- "description": "List project role by project ID.",
+ "description": "List project role by project role name.",
"length": 255,
- "name": "projectid",
- "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject",
- "required": true,
- "type": "uuid"
+ "name": "name",
+ "required": false,
+ "type": "string"
}
],
"related": "createProjectRole,updateProjectRole",
"response": [
{
- "description": "the ID of the role",
- "name": "id",
+ "description": "the description of the role",
+ "name": "description",
"type": "string"
},
- {},
{
- "description": "the id of the project",
- "name": "projectid",
+ "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"
},
{},
@@ -45275,19 +45824,15 @@
"name": "jobstatus",
"type": "integer"
},
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
+ {},
{
"description": "the name of the role",
"name": "name",
"type": "string"
},
{
- "description": "the description of the role",
- "name": "description",
+ "description": "the id of the project",
+ "name": "projectid",
"type": "string"
}
],
@@ -45310,38 +45855,38 @@
"related": "addOpenDaylightController",
"response": [
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {},
- {
"description": "the name assigned to the controller",
"name": "name",
"type": "string"
},
{
- "description": "device id of the controller",
- "name": "id",
- "type": "string"
- },
- {
"description": "the url of the controller api",
"name": "url",
"type": "string"
},
+ {},
{
"description": "the physical network to which this controller belongs to",
"name": "physicalnetworkid",
"type": "string"
},
- {},
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
{
+ "description": "device id of the controller",
+ "name": "id",
+ "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",
"type": "string"
@@ -45354,23 +45899,16 @@
"name": "updateTemplate",
"params": [
{
- "description": "true if the image supports the password reset feature; default is false",
+ "description": "true if the template type is routing i.e., if template is used to deploy router",
"length": 255,
- "name": "passwordenabled",
+ "name": "isrouting",
"required": false,
"type": "boolean"
},
{
- "description": "the name of the image file",
+ "description": "true if the image supports the password reset feature; default is false",
"length": 255,
- "name": "name",
- "required": false,
- "type": "string"
- },
- {
- "description": "true if the template type is routing i.e., if template is used to deploy router",
- "length": 255,
- "name": "isrouting",
+ "name": "passwordenabled",
"required": false,
"type": "boolean"
},
@@ -45382,20 +45920,13 @@
"type": "string"
},
{
- "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory",
+ "description": "true if the template supports the sshkey upload feature; default is false",
"length": 255,
- "name": "isdynamicallyscalable",
+ "name": "sshkeyenabled",
"required": false,
"type": "boolean"
},
{
- "description": "the type of the template",
- "length": 255,
- "name": "templatetype",
- "required": false,
- "type": "string"
- },
- {
"description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61",
"length": 255,
"name": "details",
@@ -45403,18 +45934,18 @@
"type": "map"
},
{
- "description": "true if the template supports the sshkey upload 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": "sshkeyenabled",
+ "name": "isdynamicallyscalable",
"required": false,
"type": "boolean"
},
{
- "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)",
- "length": 255,
- "name": "cleanupdetails",
+ "description": "the display text of the image",
+ "length": 4096,
+ "name": "displaytext",
"required": false,
- "type": "boolean"
+ "type": "string"
},
{
"description": "the ID of the image file",
@@ -45425,13 +45956,6 @@
"type": "uuid"
},
{
- "description": "the display text of the image",
- "length": 4096,
- "name": "displaytext",
- "required": false,
- "type": "string"
- },
- {
"description": "true if the template requres HVM, false otherwise; available only for updateTemplate API",
"length": 255,
"name": "requireshvm",
@@ -45439,6 +45963,20 @@
"type": "boolean"
},
{
+ "description": "the name of the image file",
+ "length": 255,
+ "name": "name",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "sort key of the template, integer",
+ "length": 255,
+ "name": "sortkey",
+ "required": false,
+ "type": "integer"
+ },
+ {
"description": "the ID of the OS type that best represents the OS of this image.",
"length": 255,
"name": "ostypeid",
@@ -45447,11 +45985,11 @@
"type": "uuid"
},
{
- "description": "sort key of the template, integer",
+ "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": "sortkey",
+ "name": "cleanupdetails",
"required": false,
- "type": "integer"
+ "type": "boolean"
},
{
"description": "true if image is bootable, false otherwise; available only for updateIso API",
@@ -45459,52 +45997,78 @@
"name": "bootable",
"required": false,
"type": "boolean"
+ },
+ {
+ "description": "the type of the template",
+ "length": 255,
+ "name": "templatetype",
+ "required": false,
+ "type": "string"
}
],
"related": "listIsos,registerIso,createTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos",
"response": [
{
- "description": "the template ID",
- "name": "id",
+ "description": "the ID of the domain to which the template belongs",
+ "name": "domainid",
"type": "string"
},
{
- "description": "the tag of this template",
- "name": "templatetag",
+ "description": "the name of the domain to which the template belongs",
+ "name": "domain",
"type": "string"
},
{
- "description": "the account id to which the template belongs",
- "name": "accountid",
+ "description": "if Datadisk template, then id of the root disk template this template belongs to",
+ "name": "parenttemplateid",
"type": "string"
},
{
- "description": "true if template requires HVM enabled, false otherwise",
- "name": "requireshvm",
+ "description": "the template ID of the parent template if present",
+ "name": "sourcetemplateid",
+ "type": "string"
+ },
+ {
+ "description": "the hypervisor on which the template runs",
+ "name": "hypervisor",
+ "type": "string"
+ },
+ {
+ "description": "the date this template was removed",
+ "name": "removed",
+ "type": "date"
+ },
+ {
+ "description": "true if this template is a featured template, false otherwise",
+ "name": "isfeatured",
"type": "boolean"
},
{
- "description": "the format of the template.",
- "name": "format",
- "type": "imageformat"
+ "description": "the ID of the OS type for this template.",
+ "name": "ostypeid",
+ "type": "string"
},
- {},
{
- "description": "true if the reset password feature is enabled, false otherwise",
- "name": "passwordenabled",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "true if the template is ready to be deployed from, false otherwise.",
+ "name": "isready",
"type": "boolean"
},
{
- "description": "true if the template is managed across all Zones, false otherwise",
- "name": "crossZones",
- "type": "boolean"
- },
- {
- "description": "the physical size of the template",
- "name": "physicalsize",
+ "description": "the size of the template",
+ "name": "size",
"type": "long"
},
{
+ "description": "true if template is sshkey enabled, false otherwise",
+ "name": "sshkeyenabled",
+ "type": "boolean"
+ },
+ {
"description": "the name of the OS type for this template.",
"name": "ostypename",
"type": "string"
@@ -45515,201 +46079,23 @@
"type": "string"
},
{
- "description": "the account name to which the template belongs",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the name of the secondary storage host for the template",
- "name": "hostname",
- "type": "string"
- },
- {
- "description": "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"
- },
- {
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "if root disk template, then ids of the datas disk templates this template owns",
- "name": "childtemplates",
- "type": "set"
- },
- {
- "description": "the status of the template",
- "name": "status",
- "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 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 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": "the name of the domain to which the template belongs",
- "name": "domain",
- "type": "string"
- },
- {
"description": "the ID of the zone for this template",
"name": "zoneid",
"type": "string"
},
{
- "description": "the template display text",
- "name": "displaytext",
- "type": "string"
- },
- {},
- {
- "description": "true if this template is a public template, false otherwise",
- "name": "ispublic",
- "type": "boolean"
- },
- {
- "description": "the list of resource tags associated",
- "name": "tags",
- "response": [
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "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 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"
- }
- ],
- "type": "set"
- },
- {
- "description": "the project id of the template",
- "name": "projectid",
- "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 type of the template",
- "name": "templatetype",
- "type": "string"
- },
- {
- "description": "the size of the template",
- "name": "size",
- "type": "long"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "if Datadisk template, then id of the root disk template this template belongs to",
- "name": "parenttemplateid",
- "type": "string"
- },
- {
"description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.",
"name": "deployasis",
"type": "boolean"
},
{
- "description": "true if the template is extractable, false otherwise",
- "name": "isextractable",
- "type": "boolean"
+ "description": "the 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 name of the zone for this template",
- "name": "zonename",
+ "description": "the project id of the template",
+ "name": "projectid",
"type": "string"
},
{
@@ -45718,28 +46104,120 @@
"type": "resourceiconresponse"
},
{
- "description": "true if the template is ready to be deployed from, false otherwise.",
- "name": "isready",
+ "description": "the list of resource tags associated",
+ "name": "tags",
+ "response": [
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the project 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",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "true if this template is a public template, false otherwise",
+ "name": "ispublic",
"type": "boolean"
},
{
+ "description": "the format of the template.",
+ "name": "format",
+ "type": "imageformat"
+ },
+ {
+ "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage",
+ "name": "directdownload",
+ "type": "boolean"
+ },
+ {
+ "description": "VMware only: additional key/value details tied with deploy-as-is template",
+ "name": "deployasisdetails",
+ "type": "map"
+ },
+ {
+ "description": "if root disk template, then ids of the datas disk templates this template owns",
+ "name": "childtemplates",
+ "type": "set"
+ },
+ {
+ "description": "the template display text",
+ "name": "displaytext",
+ "type": "string"
+ },
+ {
"description": "the URL which the template/iso is registered from",
"name": "url",
"type": "string"
},
{
- "description": "the project name of the template",
- "name": "project",
+ "description": "true if the ISO is bootable, false otherwise",
+ "name": "bootable",
+ "type": "boolean"
+ },
+ {
+ "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory",
+ "name": "isdynamicallyscalable",
+ "type": "boolean"
+ },
+ {
+ "description": "the name of the zone for this template",
+ "name": "zonename",
"type": "string"
},
{
- "description": "the ID of the secondary storage host for the template",
- "name": "hostid",
- "type": "string"
+ "description": "Lists the download progress of a template across all secondary storages",
+ "name": "downloaddetails",
+ "type": "list"
},
{
- "description": "true if 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"
},
{
@@ -45748,13 +46226,65 @@
"type": "date"
},
{
- "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": "the ID of the OS type for this template.",
- "name": "ostypeid",
+ "description": "true if template requires HVM enabled, false otherwise",
+ "name": "requireshvm",
+ "type": "boolean"
+ },
+ {
+ "description": "true if the template is extractable, false otherwise",
+ "name": "isextractable",
+ "type": "boolean"
+ },
+ {
+ "description": "the status of the template",
+ "name": "status",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the type of the template",
+ "name": "templatetype",
+ "type": "string"
+ },
+ {
+ "description": "true if the reset password feature is enabled, false otherwise",
+ "name": "passwordenabled",
+ "type": "boolean"
+ },
+ {
+ "description": "the project name of the template",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the physical size of the template",
+ "name": "physicalsize",
+ "type": "long"
+ },
+ {
+ "description": "additional key/value details tied with template",
+ "name": "details",
+ "type": "map"
+ },
+ {
+ "description": "the processor bit size",
+ "name": "bits",
+ "type": "int"
+ },
+ {
+ "description": "the account id to which the template belongs",
+ "name": "accountid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the ID of the secondary storage host for the template",
+ "name": "hostid",
"type": "string"
},
{
@@ -45763,8 +46293,23 @@
"type": "string"
},
{
- "description": "the template ID of the parent template if present",
- "name": "sourcetemplateid",
+ "description": "the name of the secondary storage host for the template",
+ "name": "hostname",
+ "type": "string"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the template ID",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the tag of this template",
+ "name": "templatetag",
"type": "string"
}
]
@@ -45783,21 +46328,21 @@
"type": "uuid"
},
{
- "description": "project who will own the VLAN. If VLAN is Zone wide, this parameter should be ommited",
+ "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": "projectid",
- "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "the beginning IP address in the VLAN IP range",
- "length": 255,
- "name": "startip",
+ "name": "vlan",
"required": false,
"type": "string"
},
{
+ "description": "the network id",
+ "length": 255,
+ "name": "networkid",
+ "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks",
+ "required": false,
+ "type": "uuid"
+ },
+ {
"description": "the gateway of the VLAN IP range",
"length": 255,
"name": "gateway",
@@ -45805,19 +46350,11 @@
"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"
- },
- {
- "description": "domain ID of the account owning a VLAN",
- "length": 255,
- "name": "domainid",
- "related": "listDomainChildren,listDomains,listDomains",
- "required": false,
- "type": "uuid"
+ "type": "boolean"
},
{
"description": "the ending IP address in the VLAN IP range",
@@ -45834,6 +46371,41 @@
"type": "string"
},
{
+ "description": "the ending IPv6 address in the IPv6 network range",
+ "length": 255,
+ "name": "endipv6",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the beginning IP address in the VLAN IP range",
+ "length": 255,
+ "name": "startip",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "true if IP range is set to system vms, false if not",
+ "length": 255,
+ "name": "forsystemvms",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "the beginning IPv6 address in the IPv6 network range",
+ "length": 255,
+ "name": "startipv6",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "account who will own the VLAN. If VLAN is Zone wide, this parameter should be ommited",
+ "length": 255,
+ "name": "account",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "the gateway of the IPv6 network. Required for Shared networks and Isolated networks when it belongs to VPC",
"length": 255,
"name": "ip6gateway",
@@ -45841,6 +46413,13 @@
"type": "string"
},
{
+ "description": "the CIDR of IPv6 network, must be at least /64",
+ "length": 255,
+ "name": "ip6cidr",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "optional parameter. Have to be specified for Direct Untagged vlan only.",
"length": 255,
"name": "podid",
@@ -45849,25 +46428,20 @@
"type": "uuid"
},
{
- "description": "true if IP range is set to system vms, false if not",
+ "description": "domain ID of the account owning a VLAN",
"length": 255,
- "name": "forsystemvms",
+ "name": "domainid",
+ "related": "listDomainChildren,listDomains,listDomains",
"required": false,
- "type": "boolean"
+ "type": "uuid"
},
{
- "description": "true if VLAN is of Virtual type, false if Direct",
+ "description": "project who will own the VLAN. If VLAN is Zone wide, this parameter should be ommited",
"length": 255,
- "name": "forvirtualnetwork",
+ "name": "projectid",
+ "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject",
"required": false,
- "type": "boolean"
- },
- {
- "description": "the beginning IPv6 address in the IPv6 network range",
- "length": 255,
- "name": "startipv6",
- "required": false,
- "type": "string"
+ "type": "uuid"
},
{
"description": "the physical network id",
@@ -45876,42 +46450,64 @@
"related": "createPhysicalNetwork",
"required": false,
"type": "uuid"
- },
- {
- "description": "the ending IPv6 address in the IPv6 network range",
- "length": 255,
- "name": "endipv6",
- "required": false,
- "type": "string"
- },
- {
- "description": "account who will own the VLAN. If VLAN is Zone wide, this parameter should be ommited",
- "length": 255,
- "name": "account",
- "required": false,
- "type": "string"
- },
- {
- "description": "the network id",
- "length": 255,
- "name": "networkid",
- "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "the ID or VID of the VLAN. If not specified, will be defaulted to the vlan of the network or if vlan of the network is null - to Untagged",
- "length": 255,
- "name": "vlan",
- "required": false,
- "type": "string"
}
],
"related": "updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange",
"response": [
{
- "description": "the gateway of the VLAN IP range",
- "name": "gateway",
+ "description": "the domain name of the VLAN IP range",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID of the VLAN IP range",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the project id of the vlan range",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the Pod ID for the VLAN IP range",
+ "name": "podid",
+ "type": "string"
+ },
+ {
+ "description": "the virtual network for the VLAN IP range",
+ "name": "forvirtualnetwork",
+ "type": "boolean"
+ },
+ {
+ "description": "the Zone ID of the VLAN IP range",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the netmask of the VLAN IP range",
+ "name": "netmask",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {},
+ {
+ "description": "the cidr of IPv6 network",
+ "name": "ip6cidr",
+ "type": "string"
+ },
+ {
+ "description": "the gateway of IPv6 network",
+ "name": "ip6gateway",
"type": "string"
},
{
@@ -45919,6 +46515,16 @@
"name": "endipv6",
"type": "string"
},
+ {
+ "description": "the account of the VLAN IP range",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the description of the VLAN IP range",
+ "name": "description",
+ "type": "string"
+ },
{},
{
"description": "the physical network this belongs to",
@@ -45926,74 +46532,33 @@
"type": "string"
},
{
- "description": "the domain ID of the VLAN IP range",
- "name": "domainid",
+ "description": "the ID or VID of the VLAN.",
+ "name": "vlan",
"type": "string"
},
{
- "description": "the account of the VLAN IP range",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the virtual network for the VLAN IP range",
- "name": "forvirtualnetwork",
- "type": "boolean"
- },
- {
"description": "the network id of vlan range",
"name": "networkid",
"type": "string"
},
{
- "description": "the domain name of the VLAN IP range",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the gateway of IPv6 network",
- "name": "ip6gateway",
- "type": "string"
- },
- {
"description": "the start ip of the VLAN IP range",
"name": "startip",
"type": "string"
},
{
- "description": "the ID or VID of the VLAN.",
- "name": "vlan",
- "type": "string"
+ "description": "indicates whether VLAN IP range is dedicated to system vms or not",
+ "name": "forsystemvms",
+ "type": "boolean"
},
{
- "description": "the Pod name for the VLAN IP range",
- "name": "podname",
- "type": "string"
- },
- {},
- {
"description": "the project name of the vlan range",
"name": "project",
"type": "string"
},
{
- "description": "the end ip of the VLAN IP range",
- "name": "endip",
- "type": "string"
- },
- {
- "description": "the netmask of the VLAN IP range",
- "name": "netmask",
- "type": "string"
- },
- {
- "description": "the Pod ID for the VLAN IP range",
- "name": "podid",
+ "description": "the gateway of the VLAN IP range",
+ "name": "gateway",
"type": "string"
},
{
@@ -46007,33 +46572,13 @@
"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 cidr of IPv6 network",
- "name": "ip6cidr",
- "type": "string"
- },
- {
- "description": "the Zone ID of the VLAN IP range",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "indicates whether VLAN IP range is dedicated to system vms or not",
- "name": "forsystemvms",
- "type": "boolean"
- },
- {
- "description": "the description of the VLAN IP range",
- "name": "description",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the Pod name for the VLAN IP range",
+ "name": "podname",
"type": "string"
}
]
@@ -46044,14 +46589,6 @@
"name": "updateVpnConnection",
"params": [
{
- "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only",
- "length": 255,
- "name": "customid",
- "required": false,
- "since": "4.4",
- "type": "string"
- },
- {
"description": "id of vpn connection",
"length": 255,
"name": "id",
@@ -46066,80 +46603,138 @@
"required": false,
"since": "4.4",
"type": "boolean"
+ },
+ {
+ "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only",
+ "length": 255,
+ "name": "customid",
+ "required": false,
+ "since": "4.4",
+ "type": "string"
}
],
"related": "createVpnConnection,listVpnConnections",
"response": [
- {},
{
"description": "the customer gateway ID",
"name": "s2scustomergatewayid",
"type": "string"
},
{
- "description": "State of vpn connection",
- "name": "passive",
+ "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.",
+ "name": "splitconnections",
"type": "boolean"
},
{
- "description": "the vpn gateway ID",
- "name": "s2svpngatewayid",
- "type": "string"
- },
- {
- "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).",
- "name": "cidrlist",
- "type": "string"
- },
- {
- "description": "Lifetime of ESP SA of customer gateway",
- "name": "esplifetime",
- "type": "long"
- },
- {
- "description": "ESP policy of the customer gateway",
- "name": "esppolicy",
- "type": "string"
- },
- {
- "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike",
- "name": "ikeversion",
- "type": "string"
- },
- {
- "description": "the date and time the host was removed",
- "name": "removed",
- "type": "date"
- },
- {
- "description": "the domain name of the owner",
- "name": "domain",
- "type": "string"
- },
- {
"description": "the project id",
"name": "projectid",
"type": "string"
},
{
+ "description": "the domain id of the owner",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the domain name of the owner",
+ "name": "domain",
+ "type": "string"
+ },
+ {
"description": "if Force NAT Encapsulation is enabled for customer gateway",
"name": "forceencap",
"type": "boolean"
},
{
+ "description": "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",
+ "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 removed",
+ "name": "removed",
+ "type": "date"
+ },
+ {
+ "description": "the owner",
+ "name": "account",
+ "type": "string"
+ },
+ {},
+ {},
+ {
+ "description": "the project name",
+ "name": "project",
+ "type": "string"
+ },
+ {
"description": "IPsec Preshared-Key of the customer gateway",
"name": "ipsecpsk",
"type": "string"
},
{
+ "description": "State of vpn connection",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "the vpn gateway ID",
+ "name": "s2svpngatewayid",
+ "type": "string"
+ },
+ {
+ "description": "is connection for display to the regular user",
+ "name": "fordisplay",
+ "type": "boolean"
+ },
+ {
"description": "IKE policy of the customer gateway",
"name": "ikepolicy",
"type": "string"
},
- {},
{
- "description": "the domain id of the owner",
- "name": "domainid",
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the connection ID",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).",
+ "name": "cidrlist",
+ "type": "string"
+ },
+ {
+ "description": "if DPD is enabled for customer gateway",
+ "name": "dpd",
+ "type": "boolean"
+ },
+ {
+ "description": "Lifetime of ESP SA of customer gateway",
+ "name": "esplifetime",
+ "type": "long"
+ },
+ {
+ "description": "State of vpn connection",
+ "name": "passive",
+ "type": "boolean"
+ },
+ {
+ "description": "ESP policy of the customer gateway",
+ "name": "esppolicy",
"type": "string"
},
{
@@ -46153,59 +46748,9 @@
"type": "string"
},
{
- "description": "if DPD is enabled for customer gateway",
- "name": "dpd",
- "type": "boolean"
- },
- {
- "description": "the owner",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "public ip address id of the customer gateway",
- "name": "gateway",
- "type": "string"
- },
- {
- "description": "the project name",
- "name": "project",
- "type": "string"
- },
- {
"description": "Lifetime of IKE SA of customer gateway",
"name": "ikelifetime",
"type": "long"
- },
- {
- "description": "the connection ID",
- "name": "id",
- "type": "string"
- },
- {
- "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.",
- "name": "splitconnections",
- "type": "boolean"
- },
- {
- "description": "State of vpn connection",
- "name": "state",
- "type": "string"
- },
- {
- "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"
}
],
"since": "4.4"
@@ -46230,91 +46775,26 @@
"type": "integer"
},
{
- "description": "",
- "length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
- },
- {
"description": "palo alto balancer device ID",
"length": 255,
"name": "lbdeviceid",
"related": "addPaloAltoFirewall,configurePaloAltoFirewall,listPaloAltoFirewalls",
"required": true,
"type": "uuid"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
}
],
"related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks",
"response": [
{
- "description": "true if network is system, false otherwise",
- "name": "issystem",
- "type": "boolean"
- },
- {
- "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes",
- "name": "reservediprange",
- "type": "string"
- },
- {
- "description": "true if network is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
- },
- {
- "description": "the physical network id",
- "name": "physicalnetworkid",
- "type": "string"
- },
- {
- "description": "true if network supports specifying ip ranges, false otherwise",
- "name": "specifyipranges",
- "type": "boolean"
- },
- {
- "description": "the second DNS for the network",
- "name": "dns2",
- "type": "string"
- },
- {
- "description": "the project id of the ipaddress",
- "name": "projectid",
- "type": "string"
- },
- {
- "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",
- "type": "string"
- },
- {
- "description": "ACL Id associated with the VPC network",
- "name": "aclid",
- "type": "string"
- },
- {
- "description": "VPC the network belongs to",
- "name": "vpcid",
- "type": "string"
- },
- {
- "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR",
- "name": "cidr",
- "type": "string"
- },
- {
- "description": "the project name of the address",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the gateway of IPv6 network",
- "name": "ip6gateway",
+ "description": "the network's gateway",
+ "name": "gateway",
"type": "string"
},
{
@@ -46323,68 +46803,18 @@
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "list networks that are persistent",
- "name": "ispersistent",
- "type": "boolean"
- },
- {
- "description": "the displaytext of the network",
- "name": "displaytext",
+ "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR",
+ "name": "cidr",
"type": "string"
},
{
- "description": "true if network can span multiple zones",
- "name": "strechedl2subnet",
- "type": "boolean"
- },
- {
- "description": "the details of the network",
- "name": "details",
- "type": "map"
- },
- {
- "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE",
- "name": "networkcidr",
+ "description": "VPC the network belongs to",
+ "name": "vpcid",
"type": "string"
},
{
- "description": "the total number of network traffic bytes received",
- "name": "receivedbytes",
- "type": "long"
- },
- {
- "description": "the domain id of the network owner",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the cidr of IPv6 network",
- "name": "ip6cidr",
- "type": "string"
- },
- {
- "description": "the name of the zone the network belongs to",
- "name": "zonename",
- "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": "If the network has redundant routers enabled",
- "name": "redundantrouter",
- "type": "boolean"
- },
- {
- "description": "the network's gateway",
- "name": "gateway",
+ "description": "ACL Id associated with the VPC network",
+ "name": "aclid",
"type": "string"
},
{
@@ -46393,17 +46823,57 @@
"type": "string"
},
{
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
+ "description": "broadcast uri of the network. This parameter is visible to ROOT admins only",
+ "name": "broadcasturi",
+ "type": "string"
+ },
+ {
+ "description": "the gateway of IPv6 network",
+ "name": "ip6gateway",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the address",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the displaytext of the network",
+ "name": "displaytext",
+ "type": "string"
},
{
"description": "the list of resource tags associated with network",
"name": "tags",
"response": [
{
- "description": "the project name where tag belongs to",
- "name": "project",
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
"type": "string"
},
{
@@ -46412,8 +46882,8 @@
"type": "string"
},
{
- "description": "id of the resource",
- "name": "resourceid",
+ "description": "the project name where tag belongs to",
+ "name": "project",
"type": "string"
},
{
@@ -46425,31 +46895,6 @@
"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 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"
}
],
"type": "list"
@@ -46460,55 +46905,13 @@
"type": "string"
},
{
- "description": "an optional field, whether to the display the network to the end user or not.",
- "name": "displaynetwork",
+ "description": "true network requires restart",
+ "name": "restartrequired",
"type": "boolean"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the total number of network traffic bytes sent",
- "name": "sentbytes",
- "type": "long"
- },
- {
- "description": "The external id of the network",
- "name": "externalid",
- "type": "string"
- },
- {
- "description": "Broadcast domain type of the network",
- "name": "broadcastdomaintype",
- "type": "string"
- },
- {},
- {
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
- },
- {
- "description": "related to what other network configuration",
- "name": "related",
- "type": "string"
- },
- {
- "description": "list networks available for vm deployment",
- "name": "canusefordeploy",
- "type": "boolean"
- },
- {
- "description": "the id of the network",
- "name": "id",
- "type": "string"
- },
- {},
- {
- "description": "The vlan of the network. This parameter is visible to ROOT admins only",
- "name": "vlan",
+ "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"
},
{
@@ -46517,8 +46920,43 @@
"type": "string"
},
{
- "description": "network offering id the network is created from",
- "name": "networkofferingid",
+ "description": "the first DNS for the network",
+ "name": "dns1",
+ "type": "string"
+ },
+ {
+ "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE",
+ "name": "networkcidr",
+ "type": "string"
+ },
+ {
+ "description": "the name of the zone the network belongs to",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "the id of the network",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "description": "Name of the VPC to which this network belongs",
+ "name": "vpcname",
+ "type": "string"
+ },
+ {
+ "description": "the network's netmask",
+ "name": "netmask",
+ "type": "string"
+ },
+ {
+ "description": "acl type - access type to the network",
+ "name": "acltype",
"type": "string"
},
{
@@ -46537,8 +46975,43 @@
"type": "string"
},
{
- "description": "the network domain",
- "name": "networkdomain",
+ "description": "network offering id the network is created from",
+ "name": "networkofferingid",
+ "type": "string"
+ },
+ {
+ "description": "the physical network id",
+ "name": "physicalnetworkid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the network",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "Broadcast domain type of the network",
+ "name": "broadcastdomaintype",
+ "type": "string"
+ },
+ {
+ "description": "an optional field, whether to the display the network to the end user or not.",
+ "name": "displaynetwork",
+ "type": "boolean"
+ },
+ {
+ "description": "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": "The external id of the network",
+ "name": "externalid",
"type": "string"
},
{
@@ -46547,35 +47020,135 @@
"type": "boolean"
},
{
- "description": "true network requires restart",
- "name": "restartrequired",
+ "description": "If the network has redundant routers enabled",
+ "name": "redundantrouter",
"type": "boolean"
},
{
+ "description": "the second DNS for the network",
+ "name": "dns2",
+ "type": "string"
+ },
+ {
+ "description": "the domain name of the network owner",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "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": "true if network offering is ip conserve mode enabled",
+ "name": "networkofferingconservemode",
+ "type": "boolean"
+ },
+ {
+ "description": "The vlan of the network. This parameter is visible to ROOT admins only",
+ "name": "vlan",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the total number of network traffic bytes sent",
+ "name": "sentbytes",
+ "type": "long"
+ },
+ {
+ "description": "the details of the network",
+ "name": "details",
+ "type": "map"
+ },
+ {},
+ {
+ "description": "the project id of the ipaddress",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "display text of the network offering the network is created from",
+ "name": "networkofferingdisplaytext",
+ "type": "string"
+ },
+ {
+ "description": "true if network is system, false otherwise",
+ "name": "issystem",
+ "type": "boolean"
+ },
+ {
+ "description": "list networks available for vm deployment",
+ "name": "canusefordeploy",
+ "type": "boolean"
+ },
+ {
+ "description": "true if network can span multiple zones",
+ "name": "strechedl2subnet",
+ "type": "boolean"
+ },
+ {
+ "description": "related to what other network configuration",
+ "name": "related",
+ "type": "string"
+ },
+ {
+ "description": "the network domain",
+ "name": "networkdomain",
+ "type": "string"
+ },
+ {
+ "description": "list networks that are persistent",
+ "name": "ispersistent",
+ "type": "boolean"
+ },
+ {
+ "description": "the cidr of IPv6 network",
+ "name": "ip6cidr",
+ "type": "string"
+ },
+ {
+ "description": "the domain id of the network owner",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "state of the network",
+ "name": "state",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the date this network was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the total number of network traffic bytes received",
+ "name": "receivedbytes",
+ "type": "long"
+ },
+ {
"description": "the list of 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",
@@ -46587,18 +47160,13 @@
"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",
+ "description": "uuid of the network provider",
+ "name": "id",
"type": "string"
},
{
@@ -46612,65 +47180,42 @@
"type": "string"
},
{
- "description": "uuid of the network provider",
- "name": "id",
+ "description": "state of the network provider",
+ "name": "state",
"type": "string"
+ },
+ {
+ "description": "services for this provider",
+ "name": "servicelist",
+ "type": "list"
}
],
"type": "list"
},
{
- "description": "the service name",
- "name": "name",
- "type": "string"
+ "description": "the list of capabilities",
+ "name": "capability",
+ "response": [
+ {
+ "description": "the capability name",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the capability value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "can this service capability value can be choosable while creatine network offerings",
+ "name": "canchooseservicecapability",
+ "type": "boolean"
+ }
+ ],
+ "type": "list"
}
],
"type": "list"
- },
- {
- "description": "the date this network was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the first DNS for the network",
- "name": "dns1",
- "type": "string"
- },
- {
- "description": "the network's netmask",
- "name": "netmask",
- "type": "string"
- },
- {
- "description": "true if network offering is ip conserve mode enabled",
- "name": "networkofferingconservemode",
- "type": "boolean"
- },
- {
- "description": "state of the network",
- "name": "state",
- "type": "string"
- },
- {
- "description": "the name of the network",
- "name": "name",
- "type": "string"
- },
- {
- "description": "acl type - access type to the network",
- "name": "acltype",
- "type": "string"
- },
- {
- "description": "display text of the network offering the network is created from",
- "name": "networkofferingdisplaytext",
- "type": "string"
- },
- {
- "description": "the domain name of the network owner",
- "name": "domain",
- "type": "string"
}
]
},
@@ -46691,11 +47236,6 @@
"response": [
{},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
@@ -46705,6 +47245,11 @@
"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",
+ "type": "integer"
}
]
},
@@ -46721,14 +47266,6 @@
"type": "integer"
},
{
- "description": "the id of the management server",
- "length": 255,
- "name": "id",
- "related": "listManagementServers",
- "required": false,
- "type": "uuid"
- },
- {
"description": "List by keyword",
"length": 255,
"name": "keyword",
@@ -46748,40 +47285,48 @@
"name": "pagesize",
"required": false,
"type": "integer"
+ },
+ {
+ "description": "the id of the management server",
+ "length": 255,
+ "name": "id",
+ "related": "listManagementServers",
+ "required": false,
+ "type": "uuid"
}
],
"related": "",
"response": [
+ {},
+ {},
{
"description": "the name of the management server",
"name": "name",
"type": "string"
},
{
- "description": "the version of the management server",
- "name": "version",
+ "description": "the UUID of the latest async job acting on 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 management server",
"name": "id",
"type": "string"
},
{
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
"description": "the state of the management server",
"name": "state",
"type": "state"
},
- {},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the version of the management server",
+ "name": "version",
"type": "string"
}
]
@@ -46792,52 +47337,48 @@
"name": "updateInstanceGroup",
"params": [
{
- "description": "new instance group name",
- "length": 255,
- "name": "name",
- "required": false,
- "type": "string"
- },
- {
"description": "Instance group ID",
"length": 255,
"name": "id",
"related": "createInstanceGroup,updateInstanceGroup",
"required": true,
"type": "uuid"
+ },
+ {
+ "description": "new instance group name",
+ "length": 255,
+ "name": "name",
+ "required": false,
+ "type": "string"
}
],
"related": "createInstanceGroup",
"response": [
{
- "description": "the domain name of the instance group",
- "name": "domain",
+ "description": "the account owning the instance group",
+ "name": "account",
"type": "string"
},
- {},
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the ID of the instance group",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
{
"description": "the project name of the instance group",
"name": "project",
"type": "string"
},
{
- "description": "the domain ID of the instance group",
- "name": "domainid",
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {},
+ {
+ "description": "the domain name of the instance group",
+ "name": "domain",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the name of the instance group",
+ "name": "name",
"type": "string"
},
{
@@ -46846,8 +47387,8 @@
"type": "date"
},
{
- "description": "the account owning the instance group",
- "name": "account",
+ "description": "the domain ID of the instance group",
+ "name": "domainid",
"type": "string"
},
{
@@ -46856,16 +47397,20 @@
"type": "string"
},
{
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "the name of the instance group",
- "name": "name",
+ "description": "the ID of the instance group",
+ "name": "id",
"type": "string"
},
- {}
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ }
]
},
{
@@ -46882,9 +47427,17 @@
"type": "uuid"
},
{
+ "description": "the ID of the ucs manager",
+ "length": 255,
+ "name": "id",
+ "related": "listUcsManagers,addUcsManager",
+ "required": false,
+ "type": "uuid"
+ },
+ {
"description": "",
"length": 255,
- "name": "page",
+ "name": "pagesize",
"required": false,
"type": "integer"
},
@@ -46898,32 +47451,33 @@
{
"description": "",
"length": 255,
- "name": "pagesize",
+ "name": "page",
"required": false,
"type": "integer"
- },
- {
- "description": "the ID of the ucs manager",
- "length": 255,
- "name": "id",
- "related": "listUcsManagers,addUcsManager",
- "required": false,
- "type": "uuid"
}
],
"related": "addUcsManager",
"response": [
{
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
"description": "the url of ucs manager",
"name": "url",
"type": "string"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the name of ucs manager",
+ "name": "name",
"type": "string"
},
- {},
+ {
+ "description": "the ID of the ucs manager",
+ "name": "id",
+ "type": "string"
+ },
{},
{
"description": "the current status of the latest async job acting on this object",
@@ -46931,20 +47485,11 @@
"type": "integer"
},
{
- "description": "the ID of the ucs manager",
- "name": "id",
- "type": "string"
- },
- {
"description": "the zone ID of ucs manager",
"name": "zoneid",
"type": "string"
},
- {
- "description": "the name of ucs manager",
- "name": "name",
- "type": "string"
- }
+ {}
]
},
{
@@ -46972,13 +47517,8 @@
"related": "destroyRouter,listRouters,listInternalLoadBalancerVMs",
"response": [
{
- "description": "role of the domain router",
- "name": "role",
- "type": "string"
- },
- {
- "description": "the guest IP address for the router",
- "name": "guestipaddress",
+ "description": "the public netmask for the router",
+ "name": "publicnetmask",
"type": "string"
},
{
@@ -46987,86 +47527,51 @@
"type": "string"
},
{
+ "description": "if this router is an redundant virtual router",
+ "name": "isredundantrouter",
+ "type": "boolean"
+ },
+ {
+ "description": "the version of scripts",
+ "name": "scriptsversion",
+ "type": "string"
+ },
+ {
+ "description": "the Pod ID for the router",
+ "name": "podid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the name of the corresponding guest network",
+ "name": "guestnetworkname",
+ "type": "string"
+ },
+ {
+ "description": "true if any health checks had failed",
+ "name": "healthchecksfailed",
+ "type": "boolean"
+ },
+ {
+ "description": "the link local IP address for the router",
+ "name": "linklocalip",
+ "type": "string"
+ },
+ {
"description": "the state of the router",
"name": "state",
"type": "state"
},
{
- "description": "true if the router template requires upgrader",
- "name": "requiresupgrade",
- "type": "boolean"
- },
- {
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "the second IPv6 DNS for the router",
- "name": "ip6dns2",
- "type": "string"
- },
- {
- "description": "the public netmask for the router",
- "name": "publicnetmask",
- "type": "string"
- },
- {
"description": "the guest MAC address for the router",
"name": "guestmacaddress",
"type": "string"
},
+ {},
{
- "description": "the Pod name for the router",
- "name": "podname",
- "type": "string"
- },
- {
- "description": "the template name for the router",
- "name": "templatename",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the template ID for the router",
- "name": "templateid",
- "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 date this VPC was created",
- "name": "lastupdated",
- "type": "date"
- },
- {
- "description": "result of the health check",
- "name": "success",
- "type": "boolean"
- },
- {
- "description": "the type of the health check - basic or advanced",
- "name": "checktype",
- "type": "string"
- }
- ],
- "type": "list"
+ "description": "the date and time the router was created",
+ "name": "created",
+ "type": "date"
},
{
"description": "the public MAC address for the router",
@@ -47074,23 +47579,18 @@
"type": "string"
},
{
- "description": "the hostname for the router",
- "name": "hostname",
+ "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 project name of the address",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the link local netmask for the router",
- "name": "linklocalnetmask",
- "type": "string"
- },
- {
- "description": "the ID of the corresponding public network",
- "name": "publicnetworkid",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
@@ -47099,26 +47599,160 @@
"type": "string"
},
{
- "description": "the gateway for the router",
- "name": "gateway",
+ "description": "the guest netmask for the router",
+ "name": "guestnetmask",
"type": "string"
},
- {},
+ {
+ "description": "the hostname for the router",
+ "name": "hostname",
+ "type": "string"
+ },
+ {
+ "description": "the link local netmask for the router",
+ "name": "linklocalnetmask",
+ "type": "string"
+ },
+ {
+ "description": "the host ID for the router",
+ "name": "hostid",
+ "type": "string"
+ },
+ {
+ "description": "the id of the router",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the guest IP address for the router",
+ "name": "guestipaddress",
+ "type": "string"
+ },
+ {
+ "description": "the Pod name for the router",
+ "name": "podname",
+ "type": "string"
+ },
+ {
+ "description": "the name of the router",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the corresponding guest network",
+ "name": "guestnetworkid",
+ "type": "string"
+ },
+ {
+ "description": "the name of VPC the router belongs to",
+ "name": "vpcname",
+ "type": "string"
+ },
+ {
+ "description": "the hypervisor on which the template runs",
+ "name": "hypervisor",
+ "type": "string"
+ },
+ {
+ "description": "the project id of the ipaddress",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the public IP address for the router",
+ "name": "publicip",
+ "type": "string"
+ },
+ {
+ "description": "the link local MAC address for the router",
+ "name": "linklocalmacaddress",
+ "type": "string"
+ },
{
"description": "the list of nics associated with the router",
"name": "nic",
"response": [
{
- "description": "true if nic is default, false otherwise",
- "name": "macaddress",
+ "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 ID of the corresponding network",
+ "name": "networkid",
"type": "string"
},
{
+ "description": "Id of the vm to which the nic belongs",
+ "name": "virtualmachineid",
+ "type": "string"
+ },
+ {
+ "description": "the ip address of the nic",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise",
+ "name": "nsxlogicalswitchport",
+ "type": "string"
+ },
+ {
+ "description": "the isolated private VLAN if available",
+ "name": "isolatedpvlan",
+ "type": "integer"
+ },
+ {
+ "description": "Type of adapter if available",
+ "name": "adaptertype",
+ "type": "string"
+ },
+ {
+ "description": "the netmask of the nic",
+ "name": "netmask",
+ "type": "string"
+ },
+ {
+ "description": "the broadcast uri of the nic",
+ "name": "broadcasturi",
+ "type": "string"
+ },
+ {
+ "description": "the gateway of the nic",
+ "name": "gateway",
+ "type": "string"
+ },
+ {
+ "description": "IP addresses associated with NIC found for unmanaged VM",
+ "name": "ipaddresses",
+ "type": "list"
+ },
+ {
+ "description": "the cidr of IPv6 network",
+ "name": "ip6cidr",
+ "type": "string"
+ },
+ {
+ "description": "the Secondary ipv4 addr of nic",
+ "name": "secondaryip",
+ "type": "list"
+ },
+ {
+ "description": "the name of the corresponding network",
+ "name": "networkname",
+ "type": "string"
+ },
+ {
+ "description": "the gateway of 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"
@@ -47129,21 +47763,6 @@
"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": "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"
@@ -47154,13 +47773,8 @@
"type": "string"
},
{
- "description": "the ID of the nic",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the name of the corresponding network",
- "name": "networkname",
+ "description": "device id for the network when plugged into the virtual machine",
+ "name": "deviceid",
"type": "string"
},
{
@@ -47169,58 +47783,13 @@
"type": "integer"
},
{
- "description": "the type of the nic",
- "name": "type",
- "type": "string"
- },
- {
- "description": "Type of adapter if available",
- "name": "adaptertype",
- "type": "string"
- },
- {
- "description": "the gateway of the nic",
- "name": "gateway",
- "type": "string"
- },
- {
- "description": "the broadcast uri of the nic",
- "name": "broadcasturi",
- "type": "string"
- },
- {
- "description": "the cidr of IPv6 network",
- "name": "ip6cidr",
+ "description": "Id of the NSX Logical Switch (if NSX based), null otherwise",
+ "name": "nsxlogicalswitch",
"type": "string"
},
{
"description": "true if nic is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
- },
- {
- "description": "IP addresses associated with NIC found for unmanaged VM",
- "name": "ipaddresses",
- "type": "list"
- },
- {
- "description": "the gateway of IPv6 network",
- "name": "ip6gateway",
- "type": "string"
- },
- {
- "description": "the ID of the corresponding network",
- "name": "networkid",
- "type": "string"
- },
- {
- "description": "the netmask of the nic",
- "name": "netmask",
- "type": "string"
- },
- {
- "description": "the ip address of the nic",
- "name": "ipaddress",
+ "name": "macaddress",
"type": "string"
},
{
@@ -47229,100 +47798,29 @@
"type": "list"
},
{
- "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": "the type of the nic",
+ "name": "type",
"type": "string"
}
],
"type": "set"
},
{
- "description": "the project id of the ipaddress",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the id of the router",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the host ID for the router",
- "name": "hostid",
- "type": "string"
- },
- {
"description": "the version of template",
"name": "version",
"type": "string"
},
{
- "description": "the hypervisor on which the template runs",
- "name": "hypervisor",
+ "description": "the first DNS for the router",
+ "name": "dns1",
"type": "string"
},
{
- "description": "the name of the service offering of the virtual machine",
- "name": "serviceofferingname",
- "type": "string"
- },
- {
- "description": "true if any health checks had failed",
- "name": "healthchecksfailed",
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
"type": "boolean"
},
{
- "description": "if this router is an redundant virtual router",
- "name": "isredundantrouter",
- "type": "boolean"
- },
- {
- "description": "the ID of the corresponding guest network",
- "name": "guestnetworkid",
- "type": "string"
- },
- {
- "description": "the domain associated with the router",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the Pod ID for the router",
- "name": "podid",
- "type": "string"
- },
- {
- "description": "the name of VPC the router belongs to",
- "name": "vpcname",
- "type": "string"
- },
- {},
- {
- "description": "the link local IP address for the router",
- "name": "linklocalip",
- "type": "string"
- },
- {
- "description": "the network domain for the router",
- "name": "networkdomain",
- "type": "string"
- },
- {
- "description": "the state of redundant virtual router",
- "name": "redundantstate",
- "type": "string"
- },
- {
- "description": "the version of scripts",
- "name": "scriptsversion",
- "type": "string"
- },
- {
"description": "the second DNS for the router",
"name": "dns2",
"type": "string"
@@ -47333,13 +47831,18 @@
"type": "string"
},
{
- "description": "the ID of the corresponding link local network",
- "name": "linklocalnetworkid",
+ "description": "the first IPv6 DNS for the router",
+ "name": "ip6dns1",
"type": "string"
},
{
- "description": "the link local MAC address for the router",
- "name": "linklocalmacaddress",
+ "description": "role of the domain router",
+ "name": "role",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the corresponding link local network",
+ "name": "linklocalnetworkid",
"type": "string"
},
{
@@ -47348,13 +47851,38 @@
"type": "string"
},
{
- "description": "the public IP address for the router",
- "name": "publicip",
+ "description": "the name of the service offering of the virtual machine",
+ "name": "serviceofferingname",
"type": "string"
},
{
- "description": "the name of the corresponding guest network",
- "name": "guestnetworkname",
+ "description": "the network domain for the router",
+ "name": "networkdomain",
+ "type": "string"
+ },
+ {
+ "description": "the gateway for the router",
+ "name": "gateway",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the router",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the 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 second IPv6 DNS for the router",
+ "name": "ip6dns2",
"type": "string"
},
{
@@ -47363,39 +47891,56 @@
"type": "string"
},
{
- "description": "the first IPv6 DNS for the router",
- "name": "ip6dns1",
+ "description": "the template ID for the router",
+ "name": "templateid",
"type": "string"
},
{
- "description": "the first DNS for the router",
- "name": "dns1",
- "type": "string"
- },
- {
- "description": "the guest netmask for the router",
- "name": "guestnetmask",
- "type": "string"
- },
- {
- "description": "the name of the router",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the date and time the router was created",
- "name": "created",
- "type": "date"
- },
- {
"description": "VPC the router belongs to",
"name": "vpcid",
"type": "string"
+ },
+ {
+ "description": "Last executed health check result for the router",
+ "name": "healthcheckresults",
+ "response": [
+ {
+ "description": "detailed response generated on running health check",
+ "name": "details",
+ "type": "string"
+ },
+ {
+ "description": "result of the health check",
+ "name": "success",
+ "type": "boolean"
+ },
+ {
+ "description": "the type of the health check - basic or advanced",
+ "name": "checktype",
+ "type": "string"
+ },
+ {
+ "description": "the name of the health check on the router",
+ "name": "checkname",
+ "type": "string"
+ },
+ {
+ "description": "the date this VPC was created",
+ "name": "lastupdated",
+ "type": "date"
+ }
+ ],
+ "type": "list"
+ },
+ {
+ "description": "the ID of the corresponding public network",
+ "name": "publicnetworkid",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the address",
+ "name": "project",
+ "type": "string"
}
]
},
@@ -47405,13 +47950,6 @@
"name": "deleteLdapConfiguration",
"params": [
{
- "description": "Hostname",
- "length": 255,
- "name": "hostname",
- "required": true,
- "type": "string"
- },
- {
"description": "port",
"length": 255,
"name": "port",
@@ -47419,6 +47957,13 @@
"type": "integer"
},
{
+ "description": "Hostname",
+ "length": 255,
+ "name": "hostname",
+ "required": true,
+ "type": "string"
+ },
+ {
"description": "linked domain",
"length": 255,
"name": "domainid",
@@ -47429,33 +47974,33 @@
],
"related": "addLdapConfiguration",
"response": [
- {},
- {
- "description": "port teh ldap server is running on",
- "name": "port",
- "type": "int"
- },
- {
- "description": "linked domain",
- "name": "domainid",
- "type": "string"
- },
- {},
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
{
+ "description": "name of the host running the ldap server",
+ "name": "hostname",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "linked domain",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "port teh 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": "name of the host running the ldap server",
- "name": "hostname",
- "type": "string"
- }
+ {}
],
"since": "4.2.0"
},
@@ -47465,26 +48010,17 @@
"name": "updateVolume",
"params": [
{
- "description": "Destination storage pool UUID for the volume",
+ "description": "The chain info of the volume",
"length": 255,
- "name": "storageid",
- "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool",
- "required": false,
- "since": "4.3",
- "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",
+ "name": "chaininfo",
"required": false,
"since": "4.4",
"type": "string"
},
{
- "description": "The chain info of the volume",
+ "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only",
"length": 255,
- "name": "chaininfo",
+ "name": "customid",
"required": false,
"since": "4.4",
"type": "string"
@@ -47498,12 +48034,28 @@
"type": "string"
},
{
- "description": "new name of the volume",
+ "description": "the ID of the disk volume",
"length": 255,
- "name": "name",
+ "name": "id",
+ "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume",
"required": false,
- "since": "4.16",
- "type": "string"
+ "type": "uuid"
+ },
+ {
+ "description": "Destination storage pool UUID for the volume",
+ "length": 255,
+ "name": "storageid",
+ "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool",
+ "required": false,
+ "since": "4.3",
+ "type": "uuid"
+ },
+ {
+ "description": "an optional field, whether to the display the volume to the end user or not.",
+ "length": 255,
+ "name": "displayvolume",
+ "required": false,
+ "type": "boolean"
},
{
"description": "The path of the volume",
@@ -47513,29 +48065,225 @@
"type": "string"
},
{
- "description": "the ID of the disk volume",
+ "description": "new name of the volume",
"length": 255,
- "name": "id",
- "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume",
+ "name": "name",
"required": false,
- "type": "uuid"
- },
- {
- "description": "an optional field, whether to the display the volume to the end user or not.",
- "length": 255,
- "name": "displayvolume",
- "required": false,
- "type": "boolean"
+ "since": "4.16",
+ "type": "string"
}
],
"related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume",
"response": [
{
- "description": "the name of the ISO attached to the virtual machine",
- "name": "isoname",
+ "description": "the read (bytes) of disk on the vm",
+ "name": "diskkbsread",
+ "type": "long"
+ },
+ {
+ "description": "the display text of the service offering for root disk",
+ "name": "serviceofferingdisplaytext",
"type": "string"
},
{
+ "description": "the account associated with the disk volume",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the ISO attached to the virtual machine",
+ "name": "isoid",
+ "type": "string"
+ },
+ {
+ "description": "max iops of the disk volume",
+ "name": "maxiops",
+ "type": "long"
+ },
+ {
+ "description": "ID of the service offering for root disk",
+ "name": "serviceofferingid",
+ "type": "string"
+ },
+ {
+ "description": "pod name of the volume",
+ "name": "podname",
+ "type": "string"
+ },
+ {
+ "description": "the disk utilization",
+ "name": "utilization",
+ "type": "string"
+ },
+ {
+ "description": "io requests read rate of the disk volume per the disk offering",
+ "name": "diskIopsReadRate",
+ "type": "long"
+ },
+ {
+ "description": "the name of the template for the virtual machine",
+ "name": "templatename",
+ "type": "string"
+ },
+ {
+ "description": "display name of the virtual machine",
+ "name": "vmdisplayname",
+ "type": "string"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the state of the disk volume",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "an alternate display text of the ISO attached to the virtual machine",
+ "name": "isodisplaytext",
+ "type": "string"
+ },
+ {
+ "description": "ID of the disk offering",
+ "name": "diskofferingid",
+ "type": "string"
+ },
+ {
+ "description": "the bytes allocated",
+ "name": "physicalsize",
+ "type": "long"
+ },
+ {
+ "description": "io requests write rate of the disk volume per the disk offering",
+ "name": "diskIopsWriteRate",
+ "type": "long"
+ },
+ {
+ "description": "the read (io) of disk on the vm",
+ "name": "diskioread",
+ "type": "long"
+ },
+ {
+ "description": "state of the virtual machine",
+ "name": "vmstate",
+ "type": "string"
+ },
+ {
+ "description": "cluster name where the volume is allocated",
+ "name": "clustername",
+ "type": "string"
+ },
+ {
+ "description": "name of the virtual machine",
+ "name": "vmname",
+ "type": "string"
+ },
+ {
+ "description": "need quiesce vm or not when taking snapshot",
+ "name": "quiescevm",
+ "type": "boolean"
+ },
+ {
+ "description": "size of the disk volume",
+ "name": "size",
+ "type": "long"
+ },
+ {
+ "description": "the bytes actually consumed on disk",
+ "name": "virtualsize",
+ "type": "long"
+ },
+ {
+ "description": "ID of the disk volume",
+ "name": "id",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "name of the availability zone",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.",
+ "name": "templateid",
+ "type": "string"
+ },
+ {
+ "description": "the list of resource tags associated",
+ "name": "tags",
+ "response": [
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "tag 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": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the project id of the vpn",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "cluster id of the volume",
+ "name": "clusterid",
+ "type": "string"
+ },
+ {
+ "description": "true if the volume is extractable, false otherwise",
+ "name": "isextractable",
+ "type": "boolean"
+ },
+ {
"description": "the ID of the domain associated with the disk volume",
"name": "domainid",
"type": "string"
@@ -47546,115 +48294,8 @@
"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 ISO attached to the virtual machine",
- "name": "isoid",
- "type": "string"
- },
- {
- "description": "cluster id of the volume",
- "name": "clusterid",
- "type": "string"
- },
- {
- "description": "the bytes allocated",
- "name": "physicalsize",
- "type": "long"
- },
- {
- "description": "min iops of the disk volume",
- "name": "miniops",
- "type": "long"
- },
- {
- "description": "the write (bytes) of disk on the vm",
- "name": "diskkbswrite",
- "type": "long"
- },
- {
- "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",
- "type": "string"
- },
- {
- "description": "name of the disk volume",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the status of the volume",
- "name": "status",
- "type": "string"
- },
- {
- "description": "an optional field whether to the display the volume to the end user or not.",
- "name": "displayvolume",
- "type": "boolean"
- },
- {
- "description": "the account associated with the disk volume",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the read (io) of disk on the vm",
- "name": "diskioread",
- "type": "long"
- },
- {},
- {
- "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": "the name of the template for the virtual machine",
- "name": "templatename",
- "type": "string"
- },
- {
- "description": "max iops of the disk volume",
- "name": "maxiops",
- "type": "long"
- },
- {
- "description": "the bytes actually consumed on disk",
- "name": "virtualsize",
- "type": "long"
- },
- {
- "description": "io requests write rate of the disk volume per the disk offering",
- "name": "diskIopsWriteRate",
- "type": "long"
- },
- {},
- {
- "description": "the project id of the vpn",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "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": "the project name of the vpn",
+ "name": "project",
"type": "string"
},
{
@@ -47663,13 +48304,8 @@
"type": "string"
},
{
- "description": "ID of the disk volume",
- "name": "id",
- "type": "string"
- },
- {
- "description": "display name of the virtual machine",
- "name": "vmdisplayname",
+ "description": "the chain info of the volume",
+ "name": "chaininfo",
"type": "string"
},
{
@@ -47678,53 +48314,18 @@
"type": "long"
},
{
- "description": "need quiesce vm or not when taking snapshot",
- "name": "quiescevm",
+ "description": "true if storage snapshot is supported for the volume, false otherwise",
+ "name": "supportsstoragesnapshot",
"type": "boolean"
},
{
- "description": "the boolean state of whether the volume is destroyed or not",
- "name": "destroyed",
- "type": "boolean"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": " an alternate display text of the template for the virtual machine",
- "name": "templatedisplaytext",
- "type": "string"
- },
- {
- "description": "Hypervisor the volume belongs to",
- "name": "hypervisor",
- "type": "string"
- },
- {
"description": "the date the volume was attached to a VM instance",
"name": "attached",
"type": "date"
},
{
- "description": "the path of the volume",
- "name": "path",
- "type": "string"
- },
- {
- "description": "true if the volume is extractable, false otherwise",
- "name": "isextractable",
- "type": "boolean"
- },
- {
- "description": "name of the availability zone",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "ID of the availability zone",
- "name": "zoneid",
+ "description": "shared or local storage",
+ "name": "storagetype",
"type": "string"
},
{
@@ -47733,151 +48334,9 @@
"type": "string"
},
{
- "description": "the state of the disk volume",
- "name": "state",
- "type": "string"
- },
- {
- "description": "cluster name where the volume is allocated",
- "name": "clustername",
- "type": "string"
- },
- {
- "description": "the project name of the vpn",
- "name": "project",
- "type": "string"
- },
- {
- "description": "shared or local storage",
- "name": "storagetype",
- "type": "string"
- },
- {
- "description": "true if storage snapshot is supported for the volume, false otherwise",
- "name": "supportsstoragesnapshot",
- "type": "boolean"
- },
- {
- "description": "ID of the snapshot from which this volume was created",
- "name": "snapshotid",
- "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": "the read (bytes) of disk on the vm",
- "name": "diskkbsread",
- "type": "long"
- },
- {
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "pod id of the volume",
- "name": "podid",
- "type": "string"
- },
- {
- "description": "bytes read rate of the disk volume",
- "name": "diskBytesReadRate",
- "type": "long"
- },
- {
- "description": "the list of resource tags associated",
- "name": "tags",
- "response": [
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "ID of the disk offering",
- "name": "diskofferingid",
- "type": "string"
- },
- {
- "description": "size of the disk volume",
- "name": "size",
- "type": "long"
- },
- {
- "description": "state of the virtual machine",
- "name": "vmstate",
- "type": "string"
- },
- {
- "description": "the display text of the service offering for root disk",
- "name": "serviceofferingdisplaytext",
- "type": "string"
- },
- {
- "description": "the disk utilization",
- "name": "utilization",
- "type": "string"
- },
- {
- "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": "type of the disk volume (ROOT or DATADISK)",
@@ -47885,18 +48344,33 @@
"type": "string"
},
{
+ "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": "id of the primary storage hosting the disk volume; returned to admin user only",
+ "name": "storageid",
+ "type": "string"
+ },
+ {
"description": "name of the primary storage hosting the disk volume",
"name": "storage",
"type": "string"
},
{
- "description": "provisioning type used to create volumes.",
- "name": "provisioningtype",
+ "description": "min iops of the disk volume",
+ "name": "miniops",
+ "type": "long"
+ },
+ {
+ "description": "the name of the ISO attached to the virtual machine",
+ "name": "isoname",
"type": "string"
},
{
@@ -47905,13 +48379,84 @@
"type": "string"
},
{
- "description": "io requests read rate of the disk volume per the disk offering",
- "name": "diskIopsReadRate",
+ "description": "the display text of the disk offering",
+ "name": "diskofferingdisplaytext",
+ "type": "string"
+ },
+ {
+ "description": "provisioning type used to create volumes.",
+ "name": "provisioningtype",
+ "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 snapshot from which this volume was created",
+ "name": "snapshotid",
+ "type": "string"
+ },
+ {
+ "description": "bytes read rate of the disk volume",
+ "name": "diskBytesReadRate",
"type": "long"
},
{
- "description": "name of the disk offering",
- "name": "diskofferingname",
+ "description": "the path of the volume",
+ "name": "path",
+ "type": "string"
+ },
+ {
+ "description": "the write (bytes) of disk on the vm",
+ "name": "diskkbswrite",
+ "type": "long"
+ },
+ {
+ "description": " an alternate display text of the template for the virtual machine",
+ "name": "templatedisplaytext",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "ID of the availability zone",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the date the disk volume was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the boolean state of whether the volume is destroyed or not",
+ "name": "destroyed",
+ "type": "boolean"
+ },
+ {
+ "description": "name of the disk volume",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "Hypervisor the volume belongs to",
+ "name": "hypervisor",
+ "type": "string"
+ },
+ {
+ "description": "the status of the volume",
+ "name": "status",
+ "type": "string"
+ },
+ {
+ "description": "pod id of the volume",
+ "name": "podid",
"type": "string"
}
]
@@ -47924,6 +48469,21 @@
{
"description": "",
"length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "the Physical Network ID",
+ "length": 255,
+ "name": "physicalnetworkid",
+ "related": "createPhysicalNetwork",
+ "required": true,
+ "type": "uuid"
+ },
+ {
+ "description": "",
+ "length": 255,
"name": "page",
"required": false,
"type": "integer"
@@ -47934,26 +48494,38 @@
"name": "keyword",
"required": false,
"type": "string"
- },
- {
- "description": "the Physical Network ID",
- "length": 255,
- "name": "physicalnetworkid",
- "related": "createPhysicalNetwork",
- "required": true,
- "type": "uuid"
- },
- {
- "description": "",
- "length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
}
],
"related": "listNetworkServiceProviders",
"response": [
{
+ "description": "services for this provider",
+ "name": "servicelist",
+ "type": "list"
+ },
+ {},
+ {
+ "description": "the destination physical network",
+ "name": "destinationphysicalnetworkid",
+ "type": "string"
+ },
+ {
+ "description": "state of the network provider",
+ "name": "state",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "uuid of the network provider",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the provider name",
+ "name": "name",
+ "type": "string"
+ },
+ {
"description": "true if individual services can be enabled/disabled",
"name": "canenableindividualservice",
"type": "boolean"
@@ -47964,41 +48536,14 @@
"type": "string"
},
{
- "description": "the physical network this belongs to",
- "name": "physicalnetworkid",
- "type": "string"
- },
- {
- "description": "the destination physical network",
- "name": "destinationphysicalnetworkid",
- "type": "string"
- },
- {
- "description": "the provider name",
- "name": "name",
- "type": "string"
- },
- {
- "description": "state of the network provider",
- "name": "state",
- "type": "string"
- },
- {},
- {
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
{
- "description": "uuid of the network provider",
- "name": "id",
+ "description": "the physical network this belongs to",
+ "name": "physicalnetworkid",
"type": "string"
- },
- {},
- {
- "description": "services for this provider",
- "name": "servicelist",
- "type": "list"
}
],
"since": "3.0.0"
@@ -48009,13 +48554,6 @@
"name": "createProjectRole",
"params": [
{
- "description": "The description of the Project role",
- "length": 255,
- "name": "description",
- "required": false,
- "type": "string"
- },
- {
"description": "creates a project role with this unique name",
"length": 255,
"name": "name",
@@ -48029,6 +48567,13 @@
"related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject",
"required": true,
"type": "uuid"
+ },
+ {
+ "description": "The description of the Project role",
+ "length": 255,
+ "name": "description",
+ "required": false,
+ "type": "string"
}
],
"related": "updateProjectRole",
@@ -48048,22 +48593,22 @@
"name": "name",
"type": "string"
},
- {},
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
{},
+ {},
{
"description": "the ID of the role",
"name": "id",
"type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
}
],
"since": "4.15.0"
@@ -48074,11 +48619,19 @@
"name": "updateAccount",
"params": [
{
- "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": "The UUID of the domain where the account exists",
+ "length": 255,
+ "name": "domainid",
+ "related": "listDomainChildren,listDomains,listDomains",
+ "required": false,
+ "type": "uuid"
},
{
"description": "Network domain for the account's networks; empty string will update domainName with NULL value",
@@ -48096,6 +48649,13 @@
"type": "uuid"
},
{
+ "description": "New name for the account",
+ "length": 255,
+ "name": "newname",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "Account UUID",
"length": 255,
"name": "id",
@@ -48104,100 +48664,18 @@
"type": "uuid"
},
{
- "description": "New name for the account",
+ "description": "Current account name",
"length": 255,
- "name": "newname",
+ "name": "account",
"required": false,
"type": "string"
- },
- {
- "description": "The UUID of the domain where the account exists",
- "length": 255,
- "name": "domainid",
- "related": "listDomainChildren,listDomains,listDomains",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "Details for the account used to store specific parameters",
- "length": 255,
- "name": "accountdetails",
- "required": false,
- "type": "map"
}
],
"related": "createAccount,disableAccount,enableAccount,listAccounts,listAccounts",
"response": [
{
- "description": "the total number of projects available for administration by this account",
- "name": "projectavailable",
- "type": "string"
- },
- {
- "description": "the total secondary storage space (in GiB) owned by account",
- "name": "secondarystoragetotal",
- "type": "float"
- },
- {
- "description": "the total number of cpu cores the account can own",
- "name": "cpulimit",
- "type": "string"
- },
- {},
- {
- "description": "the total volume which can be used by this account",
- "name": "volumelimit",
- "type": "string"
- },
- {
- "description": "the total number of projects being administrated by this account",
- "name": "projecttotal",
- "type": "long"
- },
- {},
- {
- "description": "the total number of vpcs the account can own",
- "name": "vpclimit",
- "type": "string"
- },
- {
- "description": "account type (admin, domain-admin, user)",
- "name": "accounttype",
- "type": "short"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the total memory (in MB) owned by account",
- "name": "memorytotal",
- "type": "long"
- },
- {
- "description": "the total primary storage space (in GiB) available to be used for this account",
- "name": "primarystorageavailable",
- "type": "string"
- },
- {
- "description": "the total secondary storage space (in GiB) available to be used for this account",
- "name": "secondarystorageavailable",
- "type": "string"
- },
- {
- "description": "the total memory (in MB) the account can own",
- "name": "memorylimit",
- "type": "string"
- },
- {
- "description": "the total number of templates which can be created by this account",
- "name": "templatelimit",
- "type": "string"
- },
- {
- "description": "the id of the account",
- "name": "id",
+ "description": "the total number of virtual machines available for this account to acquire",
+ "name": "vmavailable",
"type": "string"
},
{
@@ -48206,88 +48684,24 @@
"type": "string"
},
{
- "description": "the total number of virtual machines available for this account to acquire",
- "name": "vmavailable",
+ "description": "the total number of networks the account can own",
+ "name": "networklimit",
"type": "string"
},
{
- "description": "the total number of public ip addresses allocated for this account",
- "name": "iptotal",
- "type": "long"
- },
- {
- "description": "the default zone of the account",
- "name": "defaultzoneid",
- "type": "string"
- },
- {
- "description": "the total secondary storage space (in GiB) the account can own",
- "name": "secondarystoragelimit",
- "type": "string"
- },
- {
- "description": "the total number of projects the account can own",
- "name": "projectlimit",
- "type": "string"
+ "description": "account type (admin, domain-admin, user)",
+ "name": "accounttype",
+ "type": "short"
},
{
"description": "the date when this account was created",
"name": "created",
"type": "date"
},
+ {},
{
- "description": "true if the account requires cleanup",
- "name": "iscleanuprequired",
- "type": "boolean"
- },
- {
- "description": "the total number of networks owned by account",
- "name": "networktotal",
- "type": "long"
- },
- {
- "description": "the total number of snapshots stored by this account",
- "name": "snapshottotal",
- "type": "long"
- },
- {
- "description": "the total number of snapshots available for this account",
- "name": "snapshotavailable",
- "type": "string"
- },
- {
- "description": "the total number of networks the account can own",
- "name": "networklimit",
- "type": "string"
- },
- {
- "description": "the total number of vpcs available to be created for this account",
- "name": "vpcavailable",
- "type": "string"
- },
- {
- "description": "the name of the account",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the total primary storage space (in GiB) the account can own",
- "name": "primarystoragelimit",
- "type": "string"
- },
- {
- "description": "path of the Domain the account belongs to",
- "name": "domainpath",
- "type": "string"
- },
- {
- "description": "the total primary storage space (in GiB) owned by account",
- "name": "primarystoragetotal",
- "type": "long"
- },
- {
- "description": "the name of the role",
- "name": "rolename",
+ "description": "the state of the account",
+ "name": "state",
"type": "string"
},
{
@@ -48296,13 +48710,23 @@
"type": "long"
},
{
- "description": "the total number of virtual machines that can be deployed by this account",
- "name": "vmlimit",
+ "description": "the total number of projects being administrated by this account",
+ "name": "projecttotal",
+ "type": "long"
+ },
+ {
+ "description": "the id of the account",
+ "name": "id",
"type": "string"
},
{
- "description": "the network domain",
- "name": "networkdomain",
+ "description": "the total number of networks owned by account",
+ "name": "networktotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of cpu cores available to be created for this account",
+ "name": "cpuavailable",
"type": "string"
},
{
@@ -48310,39 +48734,40 @@
"name": "domainid",
"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 the account can own",
+ "name": "projectlimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of public ip addresses allocated for this account",
+ "name": "iptotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of virtual machines that can be deployed by this account",
+ "name": "vmlimit",
+ "type": "string"
+ },
+ {
+ "description": "the total primary storage space (in GiB) owned by account",
+ "name": "primarystoragetotal",
+ "type": "long"
+ },
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
{
- "description": "the state of the account",
- "name": "state",
- "type": "string"
- },
- {
- "description": "the total number of virtual machines stopped for this account",
- "name": "vmstopped",
- "type": "integer"
- },
- {
- "description": "the total number of templates available to be created by this account",
- "name": "templateavailable",
- "type": "string"
- },
- {
- "description": "the total number of network traffic bytes received",
- "name": "receivedbytes",
- "type": "long"
- },
- {
- "description": "the total number of templates which have been created by this account",
- "name": "templatetotal",
- "type": "long"
- },
- {
- "description": "the total number of public ip addresses this account can acquire",
- "name": "iplimit",
+ "description": "the name of the role",
+ "name": "rolename",
"type": "string"
},
{
@@ -48351,19 +48776,49 @@
"type": "long"
},
{
- "description": "details for the account",
- "name": "accountdetails",
- "type": "map"
+ "description": "true if the account requires cleanup",
+ "name": "iscleanuprequired",
+ "type": "boolean"
},
{
- "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": "name of the Domain the account 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 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": "the total volume which can be used by this account",
+ "name": "volumelimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of network traffic bytes received",
+ "name": "receivedbytes",
"type": "long"
},
{
- "description": "the list of acl groups that account belongs to",
- "name": "groups",
- "type": "list"
+ "description": "the name of the account",
+ "name": "name",
+ "type": "string"
},
{
"description": "the total number of networks available to be created for this account",
@@ -48371,83 +48826,13 @@
"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 virtual machines running for this account",
- "name": "vmrunning",
- "type": "integer"
- },
- {
"description": "the list of users associated with account",
"name": "user",
"response": [
{
- "description": "the type of the role",
- "name": "roletype",
- "type": "string"
- },
- {
- "description": "the api key of the user",
- "name": "apikey",
- "type": "string"
- },
- {
- "description": "the user ID",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the user state",
- "name": "state",
- "type": "string"
- },
- {
- "description": "the account ID of the user",
- "name": "accountid",
- "type": "string"
- },
- {
- "description": "the user email address",
- "name": "email",
- "type": "string"
- },
- {
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
- },
- {
- "description": "the account type of the user",
- "name": "accounttype",
- "type": "short"
- },
- {
- "description": "the ID of the role",
- "name": "roleid",
- "type": "string"
- },
- {
- "description": "the name of the role",
- "name": "rolename",
- "type": "string"
- },
- {
- "description": "the account name of the user",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the domain name of the user",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the user lastname",
- "name": "lastname",
- "type": "string"
+ "description": "the date and time the user account was created",
+ "name": "created",
+ "type": "date"
},
{
"description": "the user firstname",
@@ -48455,44 +48840,104 @@
"type": "string"
},
{
- "description": "the user name",
- "name": "username",
- "type": "string"
- },
- {
- "description": "the secret key of the user",
- "name": "secretkey",
- "type": "string"
- },
- {
"description": "the timezone user was created in",
"name": "timezone",
"type": "string"
},
{
+ "description": "the api key of the user",
+ "name": "apikey",
+ "type": "string"
+ },
+ {
+ "description": "the user state",
+ "name": "state",
+ "type": "string"
+ },
+ {
"description": "the source type of the user in lowercase, such as native, ldap, saml2",
"name": "usersource",
"type": "string"
},
{
+ "description": "the user email address",
+ "name": "email",
+ "type": "string"
+ },
+ {
+ "description": "the user lastname",
+ "name": "lastname",
+ "type": "string"
+ },
+ {
+ "description": "the account type of the user",
+ "name": "accounttype",
+ "type": "short"
+ },
+ {
"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 user ID",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the secret key of the user",
+ "name": "secretkey",
+ "type": "string"
+ },
+ {
+ "description": "the type of the role",
+ "name": "roletype",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the role",
+ "name": "roleid",
+ "type": "string"
+ },
+ {
+ "description": "the user name",
+ "name": "username",
+ "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 domain ID of the user",
- "name": "domainid",
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "description": "the account name of the user",
+ "name": "account",
"type": "string"
},
{
- "description": "the date and time the user account was created",
- "name": "created",
- "type": "date"
+ "description": "the domain ID of the user",
+ "name": "domainid",
+ "type": "string"
}
],
"type": "list"
@@ -48503,33 +48948,8 @@
"type": "resourceiconresponse"
},
{
- "description": "the total number of virtual machines deployed by this account",
- "name": "vmtotal",
- "type": "long"
- },
- {
- "description": "the total memory (in MB) available to be created for this account",
- "name": "memoryavailable",
- "type": "string"
- },
- {
- "description": "the total number of snapshots which can be stored by this account",
- "name": "snapshotlimit",
- "type": "string"
- },
- {
- "description": "the total volume available for this account",
- "name": "volumeavailable",
- "type": "string"
- },
- {
- "description": "the total number of vpcs owned by account",
- "name": "vpctotal",
- "type": "long"
- },
- {
- "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)",
- "name": "roletype",
+ "description": "the total number of public ip addresses this account can acquire",
+ "name": "iplimit",
"type": "string"
},
{
@@ -48538,13 +48958,138 @@
"type": "boolean"
},
{
- "description": "name of the Domain the account belongs to",
- "name": "domain",
+ "description": "the total number of snapshots which can be stored by this account",
+ "name": "snapshotlimit",
"type": "string"
},
{
- "description": "the total number of cpu cores available to be created for this account",
- "name": "cpuavailable",
+ "description": "the total number of virtual machines deployed by this account",
+ "name": "vmtotal",
+ "type": "long"
+ },
+ {
+ "description": "the total volume being used by this account",
+ "name": "volumetotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of templates which have been created by this account",
+ "name": "templatetotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of vpcs available to be created for this account",
+ "name": "vpcavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total memory (in MB) the account can own",
+ "name": "memorylimit",
+ "type": "string"
+ },
+ {
+ "description": "the network domain",
+ "name": "networkdomain",
+ "type": "string"
+ },
+ {
+ "description": "the total memory (in MB) available to be created for this account",
+ "name": "memoryavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total memory (in MB) owned by account",
+ "name": "memorytotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of snapshots available for this account",
+ "name": "snapshotavailable",
+ "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 number of templates available to be created by this account",
+ "name": "templateavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of snapshots stored by this account",
+ "name": "snapshottotal",
+ "type": "long"
+ },
+ {
+ "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)",
+ "name": "roletype",
+ "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 primary storage space (in GiB) available to be used for this account",
+ "name": "primarystorageavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of vpcs the account can own",
+ "name": "vpclimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of public ip addresses available for this account to acquire",
+ "name": "ipavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total secondary storage space (in GiB) available to be used for this account",
+ "name": "secondarystorageavailable",
+ "type": "string"
+ },
+ {
+ "description": "path of the Domain the account belongs to",
+ "name": "domainpath",
+ "type": "string"
+ },
+ {
+ "description": "details for the account",
+ "name": "accountdetails",
+ "type": "map"
+ },
+ {
+ "description": "the default zone of the account",
+ "name": "defaultzoneid",
+ "type": "string"
+ },
+ {
+ "description": "the total volume available for this account",
+ "name": "volumeavailable",
+ "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) the account can own",
+ "name": "primarystoragelimit",
"type": "string"
}
]
@@ -48573,13 +49118,50 @@
"related": "listSwifts,addImageStoreS3,listImageStores,updateCloudToUseObjectStore",
"response": [
{
+ "description": "the scope of the image store",
+ "name": "scope",
+ "type": "scopetype"
+ },
+ {
+ "description": "the name of the image store",
+ "name": "name",
+ "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 protocol of the image store",
+ "name": "protocol",
+ "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 provider name of the image store",
- "name": "providername",
+ "description": "the url of the image store",
+ "name": "url",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the image store",
+ "name": "id",
"type": "string"
},
{
@@ -48588,14 +49170,8 @@
"type": "string"
},
{
- "description": "the current status of the latest 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 provider name of the image store",
+ "name": "providername",
"type": "string"
},
{
@@ -48604,11 +49180,6 @@
"type": "string"
},
{
- "description": "the name of the image store",
- "name": "name",
- "type": "string"
- },
- {
"description": "the total disk size of the host",
"name": "disksizetotal",
"type": "long"
@@ -48617,32 +49188,6 @@
"description": "the host's currently used disk size",
"name": "disksizeused",
"type": "long"
- },
- {
- "description": "the url of the image store",
- "name": "url",
- "type": "string"
- },
- {
- "description": "the protocol of the image store",
- "name": "protocol",
- "type": "string"
- },
- {
- "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"
}
]
},
@@ -48652,6 +49197,13 @@
"name": "updateVirtualMachine",
"params": [
{
+ "description": "an optional field, whether to the display the vm to the end user or not.",
+ "length": 255,
+ "name": "displayvm",
+ "required": false,
+ "type": "boolean"
+ },
+ {
"description": "the ID of the OS type that best represents this VM.",
"length": 255,
"name": "ostypeid",
@@ -48660,11 +49212,48 @@
"type": "uuid"
},
{
- "description": "DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com",
+ "description": "group of the virtual machine",
"length": 255,
- "name": "dhcpoptionsnetworklist",
+ "name": "group",
"required": false,
- "type": "map"
+ "type": "string"
+ },
+ {
+ "description": "true if VM contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. This can be updated only when dynamic scaling is enabled on template, service offering and the corresponding global setting",
+ "length": 255,
+ "name": "isdynamicallyscalable",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "The ID of the virtual machine",
+ "length": 255,
+ "name": "id",
+ "related": "migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance",
+ "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": "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": "user generated name",
+ "length": 255,
+ "name": "displayname",
+ "required": false,
+ "type": "string"
},
{
"description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST(via POST body), you can send up to 1MB of data after base64 encoding.You also need to change vm.userdata.max.length value",
@@ -48675,16 +49264,9 @@
"type": "string"
},
{
- "description": "group of the virtual machine",
+ "description": "instance name of the user vm",
"length": 255,
- "name": "group",
- "required": false,
- "type": "string"
- },
- {
- "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only",
- "length": 255,
- "name": "customid",
+ "name": "instancename",
"required": false,
"since": "4.4",
"type": "string"
@@ -48698,26 +49280,11 @@
"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": "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": "securitygroupnames",
- "related": "createSecurityGroup",
+ "name": "dhcpoptionsnetworklist",
"required": false,
- "type": "list"
- },
- {
- "description": "true if VM contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. This can be updated only when dynamic scaling is enabled on template, service offering and the corresponding global setting",
- "length": 255,
- "name": "isdynamicallyscalable",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "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"
+ "type": "map"
},
{
"description": "Details in key/value pairs. 'extraconfig' is not allowed to be passed in details.",
@@ -48735,409 +49302,252 @@
"type": "string"
},
{
- "description": "user generated name",
- "length": 255,
- "name": "displayname",
- "required": false,
- "type": "string"
- },
- {
- "description": "an optional field, whether to the display the vm to the end user or not.",
- "length": 255,
- "name": "displayvm",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "The ID of the virtual machine",
- "length": 255,
- "name": "id",
- "related": "migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance",
- "required": true,
- "type": "uuid"
- },
- {
- "description": "instance name of the user vm",
- "length": 255,
- "name": "instancename",
- "required": false,
- "since": "4.4",
- "type": "string"
- },
- {
- "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": "true if high-availability is enabled for the virtual machine, false otherwise",
"length": 255,
"name": "haenable",
"required": false,
"type": "boolean"
+ },
+ {
+ "description": "comma separated list of security groups names that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter",
+ "length": 255,
+ "name": "securitygroupnames",
+ "related": "createSecurityGroup",
+ "required": false,
+ "type": "list"
+ },
+ {
+ "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only",
+ "length": 255,
+ "name": "customid",
+ "required": false,
+ "since": "4.4",
+ "type": "string"
}
],
"related": "migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance",
"response": [
{
- "description": "list of security groups associated with the virtual machine",
- "name": "securitygroup",
+ "description": "the target memory in vm",
+ "name": "memorytargetkbs",
+ "type": "long"
+ },
+ {
+ "description": "the date when this virtual machine was updated last time",
+ "name": "lastupdated",
+ "type": "date"
+ },
+ {
+ "description": "the project id of the vm",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "State of the Service from LB rule",
+ "name": "servicestate",
+ "type": "string"
+ },
+ {
+ "description": "the name of the virtual machine",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "device type of the root volume",
+ "name": "rootdevicetype",
+ "type": "string"
+ },
+ {
+ "description": "the name of the ISO attached to the virtual machine",
+ "name": "isoname",
+ "type": "string"
+ },
+ {
+ "description": "the memory used by the vm",
+ "name": "memorykbs",
+ "type": "long"
+ },
+ {
+ "description": "the list of resource tags associated",
+ "name": "tags",
"response": [
{
- "description": "the list of ingress rules associated with the security group",
- "name": "ingressrule",
- "response": [
- {
- "description": "the ending IP of the security group rule ",
- "name": "endport",
- "type": "integer"
- },
- {
- "description": "the list of resource tags associated with the rule",
- "name": "tags",
- "response": [
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the protocol of the security group rule",
- "name": "protocol",
- "type": "string"
- },
- {
- "description": "the CIDR notation for the base IP address of the security group rule",
- "name": "cidr",
- "type": "string"
- },
- {
- "description": "the type of the ICMP message response",
- "name": "icmptype",
- "type": "integer"
- },
- {
- "description": "the code for the ICMP message response",
- "name": "icmpcode",
- "type": "integer"
- },
- {
- "description": "the starting IP of the security group rule",
- "name": "startport",
- "type": "integer"
- },
- {
- "description": "security group name",
- "name": "securitygroupname",
- "type": "string"
- },
- {
- "description": "account owning the security group rule",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the id of the security group rule",
- "name": "ruleid",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the domain ID of the security group",
- "name": "domainid",
+ "description": "tag value",
+ "name": "value",
"type": "string"
},
{
- "description": "the account owning the security group",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the ID of the security group",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the description of the security group",
- "name": "description",
- "type": "string"
- },
- {
- "description": "the list of egress rules associated with the security group",
- "name": "egressrule",
- "response": [
- {
- "description": "the list of resource tags associated with the rule",
- "name": "tags",
- "response": [
- {
- "description": "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": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the type of the ICMP message response",
- "name": "icmptype",
- "type": "integer"
- },
- {
- "description": "the 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 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 starting IP of the security group rule",
- "name": "startport",
- "type": "integer"
- }
- ],
- "type": "set"
- },
- {
- "description": "the number of virtualmachines associated with this securitygroup",
- "name": "virtualmachinecount",
- "type": "integer"
- },
- {
- "description": "the project name of the group",
+ "description": "the project name where tag belongs to",
"name": "project",
"type": "string"
},
{
- "description": "the list of resource tags associated with the rule",
- "name": "tags",
- "response": [
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the 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": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the project id of the group",
- "name": "projectid",
+ "description": "the account associated with the tag",
+ "name": "account",
"type": "string"
},
{
- "description": "the name of the security group",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the domain name of the security group",
+ "description": "the domain associated with the tag",
"name": "domain",
"type": "string"
},
{
- "description": "the list of virtualmachine ids associated with this securitygroup",
- "name": "virtualmachineids",
- "type": "set"
+ "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": "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"
}
],
"type": "set"
},
{
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
+ "description": "the number of cpu this virtual machine is running with",
+ "name": "cpunumber",
+ "type": "integer"
+ },
+ {
+ "description": "the speed of each cpu",
+ "name": "cpuspeed",
+ "type": "integer"
+ },
+ {
+ "description": "the hypervisor on which the template runs",
+ "name": "hypervisor",
+ "type": "string"
+ },
+ {
+ "description": "the name of the backup offering of the virtual machine",
+ "name": "backupofferingname",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the service offering of the virtual machine",
+ "name": "serviceofferingid",
+ "type": "string"
+ },
+ {
+ "description": "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 vgpu type used by the virtual machine",
+ "name": "vgpu",
+ "type": "string"
+ },
+ {
+ "description": "the read (bytes) of disk on the vm",
+ "name": "diskkbsread",
+ "type": "long"
+ },
+ {
+ "description": "an optional field whether to the display the vm to the end user or not.",
+ "name": "displayvm",
+ "type": "boolean"
+ },
+ {},
+ {
+ "description": "the write (bytes) of disk on the vm",
+ "name": "diskkbswrite",
+ "type": "long"
+ },
+ {
+ "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 group name of the virtual machine",
+ "name": "group",
+ "type": "string"
+ },
+ {
+ "description": "the name of the service offering of the virtual machine",
+ "name": "serviceofferingname",
+ "type": "string"
+ },
+ {
+ "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",
"type": "string"
},
{
- "description": "the name of the host for the virtual machine",
- "name": "hostname",
- "type": "string"
- },
- {},
- {
- "description": "the read (io) of disk on the vm",
- "name": "diskioread",
+ "description": "the incoming network traffic on the vm",
+ "name": "networkkbsread",
"type": "long"
},
{
- "description": "the project id of the vm",
- "name": "projectid",
+ "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",
+ "type": "string"
+ },
+ {
+ "description": "the user's ID who deployed the virtual machine",
+ "name": "userid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the domain in which the virtual machine exists",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the date when this virtual machine was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the pool type of the virtual machine",
+ "name": "pooltype",
+ "type": "string"
+ },
+ {
+ "description": "OS type id of the vm",
+ "name": "ostypeid",
"type": "string"
},
{
@@ -49146,85 +49556,151 @@
"type": "long"
},
{
- "description": "the name of the template for the virtual machine",
- "name": "templatename",
- "type": "string"
- },
- {
"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",
- "name": "diskofferingname",
+ "description": "the write (io) of disk on the vm",
+ "name": "diskiowrite",
+ "type": "long"
+ },
+ {
+ "description": "the outgoing network traffic on the host",
+ "name": "networkkbswrite",
+ "type": "long"
+ },
+ {
+ "description": "the ID of the domain in which the virtual machine exists",
+ "name": "domainid",
"type": "string"
},
{
+ "description": "ssh key-pair",
+ "name": "keypair",
+ "type": "string"
+ },
+ {
+ "description": "device ID of the root volume",
+ "name": "rootdeviceid",
+ "type": "long"
+ },
+ {
+ "description": "the project name of the vm",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "Vm details in key/value pairs.",
+ "name": "details",
+ "type": "map"
+ },
+ {
+ "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.",
+ "name": "isdynamicallyscalable",
+ "type": "boolean"
+ },
+ {
+ "description": "public IP address id associated with vm via Static nat rule",
+ "name": "publicip",
+ "type": "string"
+ },
+ {
+ "description": "true if high-availability is enabled, false otherwise",
+ "name": "haenable",
+ "type": "boolean"
+ },
+ {
+ "description": "the internal memory that's free in vm or zero if it can not be calculated",
+ "name": "memoryintfreekbs",
+ "type": "long"
+ },
+ {},
+ {
+ "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": "the group ID of the virtual machine",
+ "name": "groupid",
+ "type": "string"
+ },
+ {
+ "description": "the total number of network traffic bytes received",
+ "name": "receivedbytes",
+ "type": "long"
+ },
+ {
+ "description": " an alternate display text of the template for the virtual machine",
+ "name": "templatedisplaytext",
+ "type": "string"
+ },
+ {
+ "description": "the 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": "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",
+ "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": "Guest vm Boot Mode",
+ "name": "bootmode",
+ "type": "string"
+ },
+ {
+ "description": "the memory allocated for the virtual machine",
+ "name": "memory",
+ "type": "integer"
+ },
+ {
"description": "the list of nics associated with vm",
"name": "nic",
"response": [
{
- "description": "Id of the vm to which the nic belongs",
- "name": "virtualmachineid",
+ "description": "the IPv6 address of network",
+ "name": "ip6address",
"type": "string"
},
{
- "description": "the extra dhcp options on the nic",
- "name": "extradhcpoption",
+ "description": "IP addresses associated with NIC found for unmanaged VM",
+ "name": "ipaddresses",
"type": "list"
},
{
- "description": "the traffic type of the nic",
- "name": "traffictype",
- "type": "string"
- },
- {
- "description": "the netmask of the nic",
- "name": "netmask",
- "type": "string"
- },
- {
- "description": "the isolated private VLAN type if available",
- "name": "isolatedpvlantype",
- "type": "string"
- },
- {
- "description": "the isolated private VLAN if available",
- "name": "isolatedpvlan",
- "type": "integer"
- },
- {
"description": "the type of the nic",
"name": "type",
"type": "string"
},
{
- "description": "the gateway of the nic",
- "name": "gateway",
- "type": "string"
- },
- {
- "description": "the cidr of IPv6 network",
- "name": "ip6cidr",
- "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": "device id for the network when plugged into the virtual machine",
- "name": "deviceid",
- "type": "string"
- },
- {
"description": "the ID of the corresponding network",
"name": "networkid",
"type": "string"
@@ -49235,18 +49711,38 @@
"type": "boolean"
},
{
- "description": "ID of the VLAN/VNI if available",
- "name": "vlanid",
- "type": "integer"
- },
- {
- "description": "the gateway of IPv6 network",
- "name": "ip6gateway",
+ "description": "Type of adapter if available",
+ "name": "adaptertype",
"type": "string"
},
{
- "description": "Id of the NSX Logical Switch (if NSX based), null otherwise",
- "name": "nsxlogicalswitch",
+ "description": "the isolated private VLAN if available",
+ "name": "isolatedpvlan",
+ "type": "integer"
+ },
+ {
+ "description": "the isolated private VLAN type if available",
+ "name": "isolatedpvlantype",
+ "type": "string"
+ },
+ {
+ "description": "the netmask of the nic",
+ "name": "netmask",
+ "type": "string"
+ },
+ {
+ "description": "Id of the vm to which the nic belongs",
+ "name": "virtualmachineid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the nic",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the name of the corresponding network",
+ "name": "networkname",
"type": "string"
},
{
@@ -49255,13 +49751,8 @@
"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 gateway of IPv6 network",
+ "name": "ip6gateway",
"type": "string"
},
{
@@ -49270,46 +49761,92 @@
"type": "string"
},
{
- "description": "the Secondary ipv4 addr of nic",
- "name": "secondaryip",
- "type": "list"
- },
- {
- "description": "Type of adapter if available",
- "name": "adaptertype",
- "type": "string"
- },
- {
"description": "the isolation uri of the nic",
"name": "isolationuri",
"type": "string"
},
{
- "description": "the IPv6 address of network",
- "name": "ip6address",
+ "description": "the Secondary ipv4 addr of nic",
+ "name": "secondaryip",
+ "type": "list"
+ },
+ {
+ "description": "the ip address of the nic",
+ "name": "ipaddress",
"type": "string"
},
{
- "description": "the name of the corresponding network",
- "name": "networkname",
+ "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": "macaddress",
+ "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 extra dhcp options on the nic",
+ "name": "extradhcpoption",
+ "type": "list"
+ },
+ {
+ "description": "Id of the NSX Logical Switch (if NSX based), null otherwise",
+ "name": "nsxlogicalswitch",
+ "type": "string"
+ },
+ {
+ "description": "ID of the VLAN/VNI if available",
+ "name": "vlanid",
+ "type": "integer"
}
],
"type": "set"
},
{
- "description": "the project name of the vm",
- "name": "project",
+ "description": "the read (io) of disk on the vm",
+ "name": "diskioread",
+ "type": "long"
+ },
+ {
+ "description": "the ID of the availablility zone for the virtual machine",
+ "name": "zoneid",
"type": "string"
},
{
+ "description": "the ID of the virtual machine",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "instance name of the user vm; this parameter is returned to the ROOT admin only",
+ "name": "instancename",
+ "type": "string"
+ },
+ {},
+ {
"description": "list of 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 account owning the affinity group",
+ "name": "account",
+ "type": "string"
},
{
"description": "the domain name of the affinity group",
@@ -49322,8 +49859,18 @@
"type": "string"
},
{
- "description": "the description of the affinity group",
- "name": "description",
+ "description": "the project name of the affinity group",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "virtual machine IDs associated with this affinity group",
+ "name": "virtualmachineIds",
+ "type": "list"
+ },
+ {
+ "description": "the type of the affinity group",
+ "name": "type",
"type": "string"
},
{
@@ -49332,51 +49879,363 @@
"type": "string"
},
{
- "description": "the account owning the affinity group",
- "name": "account",
- "type": "string"
- },
- {
"description": "the domain ID of the affinity group",
"name": "domainid",
"type": "string"
},
{
- "description": "the type of the affinity group",
- "name": "type",
+ "description": "the description of the affinity group",
+ "name": "description",
"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": "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 affinity group",
+ "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": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the 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"
+ }
+ ],
+ "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 list of resource tags associated with the rule",
+ "name": "tags",
+ "response": [
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "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"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the protocol of the security group rule",
+ "name": "protocol",
+ "type": "string"
+ },
+ {
+ "description": "the id of the security group rule",
+ "name": "ruleid",
+ "type": "string"
+ },
+ {
+ "description": "the starting IP of the security group rule",
+ "name": "startport",
+ "type": "integer"
+ },
+ {
+ "description": "the ending IP of the security group rule ",
+ "name": "endport",
+ "type": "integer"
+ },
+ {
+ "description": "the code for the ICMP message response",
+ "name": "icmpcode",
+ "type": "integer"
+ },
+ {
+ "description": "the CIDR notation for the base IP address of the security group rule",
+ "name": "cidr",
+ "type": "string"
+ },
+ {
+ "description": "account owning the security group rule",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "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 ingress rules associated with the security group",
+ "name": "ingressrule",
+ "response": [
+ {
+ "description": "the code for the ICMP message response",
+ "name": "icmpcode",
+ "type": "integer"
+ },
+ {
+ "description": "the CIDR notation for the base IP address of the security group rule",
+ "name": "cidr",
+ "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 starting IP of the security group rule",
+ "name": "startport",
+ "type": "integer"
+ },
+ {
+ "description": "the list of resource tags associated with the rule",
+ "name": "tags",
+ "response": [
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the 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": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the id of the security group rule",
+ "name": "ruleid",
+ "type": "string"
+ },
+ {
+ "description": "the type of the ICMP message response",
+ "name": "icmptype",
+ "type": "integer"
+ },
+ {
+ "description": "account owning the security group rule",
+ "name": "account",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the number of virtualmachines associated with this securitygroup",
+ "name": "virtualmachinecount",
+ "type": "integer"
+ },
+ {
+ "description": "the project id of the group",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the security group",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the group",
"name": "project",
"type": "string"
+ },
+ {
+ "description": "the domain ID of the security group",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the domain name of the security group",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the security group",
+ "name": "id",
+ "type": "string"
}
],
"type": "set"
},
{
- "description": "public IP address id associated with vm via Static nat rule",
- "name": "publicip",
- "type": "string"
- },
- {
- "description": "device ID of the root volume",
- "name": "rootdeviceid",
- "type": "long"
- },
- {
- "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.",
- "name": "isdynamicallyscalable",
- "type": "boolean"
- },
- {
- "description": "the name of the virtual machine",
- "name": "name",
+ "description": "the ID of the disk offering of the virtual machine",
+ "name": "diskofferingid",
"type": "string"
},
{
@@ -49385,88 +50244,13 @@
"type": "string"
},
{
- "description": "the date when this virtual machine was updated last time",
- "name": "lastupdated",
- "type": "date"
- },
- {
- "description": "the number of cpu this virtual machine is running with",
- "name": "cpunumber",
- "type": "integer"
- },
- {
- "description": "the write (io) of disk on the vm",
- "name": "diskiowrite",
- "type": "long"
- },
- {
- "description": "public IP address id associated with vm via Static nat rule",
- "name": "publicipid",
- "type": "string"
- },
- {
- "description": "ssh key-pair",
- "name": "keypair",
- "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 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 virtual machine",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the name of the backup offering of the virtual machine",
- "name": "backupofferingname",
- "type": "string"
- },
- {
- "description": "the virtual network for the service offering",
- "name": "forvirtualnetwork",
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
"type": "boolean"
},
{
- "description": "the hypervisor on which the template runs",
- "name": "hypervisor",
- "type": "string"
- },
- {
- "description": "Guest vm Boot Type",
- "name": "boottype",
- "type": "string"
- },
- {
- "description": "the state of the virtual machine",
- "name": "state",
- "type": "string"
- },
- {
- "description": "the vgpu type used by the virtual machine",
- "name": "vgpu",
- "type": "string"
- },
- {
- "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.",
- "name": "templateid",
- "type": "string"
- },
- {
- "description": "Guest vm Boot Mode",
- "name": "bootmode",
+ "description": "the name of the disk offering of the virtual machine",
+ "name": "diskofferingname",
"type": "string"
},
{
@@ -49475,262 +50259,23 @@
"type": "resourceiconresponse"
},
{
+ "description": "List of read-only Vm details as comma separated string.",
+ "name": "readonlydetails",
+ "type": "string"
+ },
+ {
"description": "Os type ID of the virtual machine",
"name": "guestosid",
"type": "string"
},
{
- "description": "the speed of each cpu",
- "name": "cpuspeed",
- "type": "integer"
- },
- {
- "description": "the amount of the vm's CPU currently used",
- "name": "cpuused",
- "type": "string"
- },
- {
- "description": "the ID of the host for the virtual machine",
- "name": "hostid",
- "type": "string"
- },
- {
- "description": "the list of resource tags associated",
- "name": "tags",
- "response": [
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "the 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": "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 project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "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",
"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 backup offering of the virtual machine",
- "name": "backupofferingid",
- "type": "string"
- },
- {
- "description": "the name of the service offering of the virtual machine",
- "name": "serviceofferingname",
- "type": "string"
- },
- {
- "description": "the internal memory that's free in vm or zero if it can not be calculated",
- "name": "memoryintfreekbs",
- "type": "long"
- },
- {
- "description": "the memory allocated for the virtual machine",
- "name": "memory",
- "type": "integer"
- },
- {
- "description": "the outgoing network traffic on the host",
- "name": "networkkbswrite",
- "type": "long"
- },
- {
- "description": "the memory used by the vm",
- "name": "memorykbs",
- "type": "long"
- },
- {
- "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": "true if high-availability is enabled, false otherwise",
- "name": "haenable",
- "type": "boolean"
- },
- {
- "description": "the ID of the disk offering of the virtual machine",
- "name": "diskofferingid",
- "type": "string"
- },
- {
- "description": "the write (bytes) of disk on the vm",
- "name": "diskkbswrite",
- "type": "long"
- },
- {
- "description": " an alternate display text of the template for the virtual machine",
- "name": "templatedisplaytext",
- "type": "string"
- },
- {
- "description": "the incoming network traffic on the vm",
- "name": "networkkbsread",
- "type": "long"
- },
- {
- "description": "the user's ID who deployed the virtual machine",
- "name": "userid",
- "type": "string"
- },
- {
- "description": "OS name of the vm",
- "name": "osdisplayname",
- "type": "string"
- },
- {},
- {
- "description": "OS type id of the vm",
- "name": "ostypeid",
- "type": "string"
- },
- {
- "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": "the total number of network traffic bytes received",
- "name": "receivedbytes",
- "type": "long"
- },
- {
- "description": "an alternate display text of the ISO attached to the virtual machine",
- "name": "isodisplaytext",
- "type": "string"
- },
- {
- "description": "the name of the availability zone for the virtual machine",
- "name": "zonename",
- "type": "string"
- },
- {},
- {
- "description": "device type of the root volume",
- "name": "rootdevicetype",
- "type": "string"
- },
- {
- "description": "the ID of the availablility zone for the virtual machine",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "List of read-only Vm details as comma separated string.",
- "name": "readonlydetails",
- "type": "string"
- },
- {
- "description": "the name of the ISO attached to the virtual machine",
- "name": "isoname",
- "type": "string"
- },
- {
- "description": "the name of the domain in which the virtual machine exists",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the read (bytes) of disk on the vm",
- "name": "diskkbsread",
- "type": "long"
- },
- {
- "description": "an optional field whether to the display the vm to the end user or not.",
- "name": "displayvm",
- "type": "boolean"
- },
- {
- "description": "the group name of the virtual machine",
- "name": "group",
- "type": "string"
- },
- {
- "description": "Vm details in key/value pairs.",
- "name": "details",
- "type": "map"
- },
- {
- "description": "the target memory in vm",
- "name": "memorytargetkbs",
- "type": "long"
- },
- {
- "description": "true if the password rest feature is enabled, false otherwise",
- "name": "passwordenabled",
- "type": "boolean"
- },
- {
- "description": "the pool type of the virtual machine",
- "name": "pooltype",
+ "description": "Guest vm Boot Type",
+ "name": "boottype",
"type": "string"
}
]
@@ -49741,13 +50286,6 @@
"name": "disableAccount",
"params": [
{
- "description": "Disables specified account.",
- "length": 255,
- "name": "account",
- "required": false,
- "type": "string"
- },
- {
"description": "Disables specified account in this domain.",
"length": 255,
"name": "domainid",
@@ -49764,6 +50302,13 @@
"type": "uuid"
},
{
+ "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",
@@ -49774,47 +50319,319 @@
"related": "createAccount,enableAccount,listAccounts,listAccounts",
"response": [
{
- "description": "path of the Domain the account belongs to",
- "name": "domainpath",
+ "description": "the total number of public ip addresses this account can acquire",
+ "name": "iplimit",
"type": "string"
},
{
+ "description": "the total primary storage space (in GiB) owned by account",
+ "name": "primarystoragetotal",
+ "type": "long"
+ },
+ {
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "description": "the total number of cpu cores the account can own",
+ "name": "cpulimit",
+ "type": "string"
+ },
+ {
+ "description": "the total volume which can be used by this account",
+ "name": "volumelimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of vpcs owned by account",
+ "name": "vpctotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of snapshots stored by this account",
+ "name": "snapshottotal",
+ "type": "long"
+ },
+ {
+ "description": "the list of acl groups that account belongs to",
+ "name": "groups",
+ "type": "list"
+ },
+ {
+ "description": "the total number of snapshots which can be stored by this account",
+ "name": "snapshotlimit",
+ "type": "string"
+ },
+ {
+ "description": "the total volume available for this account",
+ "name": "volumeavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of virtual machines that can be deployed by this account",
+ "name": "vmlimit",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the total number of virtual machines stopped for this account",
+ "name": "vmstopped",
+ "type": "integer"
+ },
+ {
"description": "the total memory (in MB) the account can own",
"name": "memorylimit",
"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": "the total primary storage space (in GiB) available to be used for this account",
+ "name": "primarystorageavailable",
+ "type": "string"
+ },
+ {
+ "description": "the name of the role",
+ "name": "rolename",
+ "type": "string"
+ },
+ {
+ "description": "the total number of public ip addresses allocated for this account",
+ "name": "iptotal",
+ "type": "long"
+ },
+ {
+ "description": "the total secondary storage space (in GiB) available to be used for this account",
+ "name": "secondarystorageavailable",
+ "type": "string"
+ },
+ {
+ "description": "id of the Domain the account belongs to",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the total secondary storage space (in GiB) the account can own",
+ "name": "secondarystoragelimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of network traffic bytes received",
+ "name": "receivedbytes",
+ "type": "long"
+ },
+ {
+ "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)",
+ "name": "roletype",
+ "type": "string"
+ },
+ {
+ "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 templates which can be created by this account",
+ "name": "templatelimit",
+ "type": "string"
+ },
+ {
+ "description": "the state of the account",
+ "name": "state",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the network domain",
+ "name": "networkdomain",
+ "type": "string"
+ },
+ {
+ "description": "true if the account requires cleanup",
+ "name": "iscleanuprequired",
+ "type": "boolean"
+ },
+ {
+ "description": "the total secondary storage space (in GiB) owned by account",
+ "name": "secondarystoragetotal",
+ "type": "float"
+ },
+ {
+ "description": "true if account is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {
+ "description": "the total number of templates available to be created by this account",
+ "name": "templateavailable",
+ "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 total number of networks the account can own",
+ "name": "networklimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of projects the account can own",
+ "name": "projectlimit",
+ "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 available for this account",
+ "name": "snapshotavailable",
+ "type": "string"
+ },
+ {
"description": "the total number of virtual machines deployed by this account",
"name": "vmtotal",
"type": "long"
},
{
+ "description": "the total primary storage space (in GiB) the account can own",
+ "name": "primarystoragelimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of cpu cores available to be created for this account",
+ "name": "cpuavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total memory (in MB) available to be created for this account",
+ "name": "memoryavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total memory (in MB) owned by account",
+ "name": "memorytotal",
+ "type": "long"
+ },
+ {
+ "description": "the id of the account",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the total number of virtual machines available for this account to acquire",
+ "name": "vmavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of projects available for administration by this account",
+ "name": "projectavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of network traffic bytes sent",
+ "name": "sentbytes",
+ "type": "long"
+ },
+ {
+ "description": "the total volume being used by this account",
+ "name": "volumetotal",
+ "type": "long"
+ },
+ {
+ "description": "path of the Domain the account belongs to",
+ "name": "domainpath",
+ "type": "string"
+ },
+ {
+ "description": "the total number of public ip addresses available for this account to acquire",
+ "name": "ipavailable",
+ "type": "string"
+ },
+ {
+ "description": "account type (admin, domain-admin, user)",
+ "name": "accounttype",
+ "type": "short"
+ },
+ {
+ "description": "the ID of the role",
+ "name": "roleid",
+ "type": "string"
+ },
+ {
+ "description": "the total number of vpcs available to be created for this account",
+ "name": "vpcavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of projects being administrated by this account",
+ "name": "projecttotal",
+ "type": "long"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the total number of virtual machines running for this account",
+ "name": "vmrunning",
+ "type": "integer"
+ },
+ {
+ "description": "the total number of vpcs the account can own",
+ "name": "vpclimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of networks available to be created for this account",
+ "name": "networkavailable",
+ "type": "string"
+ },
+ {
+ "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 user firstname",
- "name": "firstname",
+ "description": "the account ID of the user",
+ "name": "accountid",
"type": "string"
},
{
- "description": "the ID of the role",
- "name": "roleid",
- "type": "string"
- },
- {
- "description": "the timezone user was created in",
- "name": "timezone",
- "type": "string"
- },
- {
- "description": "the domain name of the user",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the type of the role",
- "name": "roletype",
+ "description": "the source type of the user in lowercase, such as native, ldap, saml2",
+ "name": "usersource",
"type": "string"
},
{
@@ -49823,33 +50640,8 @@
"type": "string"
},
{
- "description": "the account ID of the user",
- "name": "accountid",
- "type": "string"
- },
- {
- "description": "the boolean value representing if the updating target is in caller's child domain",
- "name": "iscallerchilddomain",
- "type": "boolean"
- },
- {
- "description": "the account type of the user",
- "name": "accounttype",
- "type": "short"
- },
- {
- "description": "the api key of the user",
- "name": "apikey",
- "type": "string"
- },
- {
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
- },
- {
- "description": "the user lastname",
- "name": "lastname",
+ "description": "the secret key of the user",
+ "name": "secretkey",
"type": "string"
},
{
@@ -49863,28 +50655,38 @@
"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 user ID",
- "name": "id",
+ "description": "the domain name of the user",
+ "name": "domain",
"type": "string"
},
{
- "description": "true if user is default, false otherwise",
- "name": "isdefault",
+ "description": "the boolean value representing if the updating target is in caller's child domain",
+ "name": "iscallerchilddomain",
"type": "boolean"
},
{
- "description": "the user email address",
- "name": "email",
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "description": "the user firstname",
+ "name": "firstname",
"type": "string"
},
{
- "description": "the name of the role",
- "name": "rolename",
+ "description": "the user lastname",
+ "name": "lastname",
+ "type": "string"
+ },
+ {
+ "description": "the type of the role",
+ "name": "roletype",
"type": "string"
},
{
@@ -49893,304 +50695,47 @@
"type": "string"
},
{
+ "description": "true if user is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {
"description": "the date and time the user account was created",
"name": "created",
"type": "date"
},
{
- "description": "the secret key of the user",
- "name": "secretkey",
+ "description": "the user email address",
+ "name": "email",
+ "type": "string"
+ },
+ {
+ "description": "the api key of the user",
+ "name": "apikey",
+ "type": "string"
+ },
+ {
+ "description": "the account type of the user",
+ "name": "accounttype",
+ "type": "short"
+ },
+ {
+ "description": "the name of the role",
+ "name": "rolename",
+ "type": "string"
+ },
+ {
+ "description": "the user ID",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the timezone user was created in",
+ "name": "timezone",
"type": "string"
}
],
"type": "list"
- },
- {
- "description": "the total number of public ip addresses allocated for this account",
- "name": "iptotal",
- "type": "long"
- },
- {
- "description": "the total number of templates available to be created by this account",
- "name": "templateavailable",
- "type": "string"
- },
- {
- "description": "the total volume which can be used by this account",
- "name": "volumelimit",
- "type": "string"
- },
- {
- "description": "the total primary storage space (in GiB) available to be used for this account",
- "name": "primarystorageavailable",
- "type": "string"
- },
- {
- "description": "the date when this account was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the total number of vpcs owned by account",
- "name": "vpctotal",
- "type": "long"
- },
- {
- "description": "the total number of network traffic bytes sent",
- "name": "sentbytes",
- "type": "long"
- },
- {
- "description": "the total number of networks available to be created for this account",
- "name": "networkavailable",
- "type": "string"
- },
- {
- "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 cpu cores owned by account",
- "name": "cputotal",
- "type": "long"
- },
- {
- "description": "the total number of network traffic bytes received",
- "name": "receivedbytes",
- "type": "long"
- },
- {
- "description": "the total number of cpu cores available to be created for this account",
- "name": "cpuavailable",
- "type": "string"
- },
- {
- "description": "the total number of virtual machines stopped for this account",
- "name": "vmstopped",
- "type": "integer"
- },
- {
- "description": "the total 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",
- "type": "string"
- },
- {},
- {
- "description": "the total secondary storage space (in GiB) available to be used for this account",
- "name": "secondarystorageavailable",
- "type": "string"
- },
- {
- "description": "id of the Domain the account belongs to",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the 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 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 primary storage space (in GiB) owned by account",
- "name": "primarystoragetotal",
- "type": "long"
- },
- {
- "description": "the id of the account",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the total number of projects being administrated by this account",
- "name": "projecttotal",
- "type": "long"
- },
- {
- "description": "the total number of snapshots available for this account",
- "name": "snapshotavailable",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {},
- {
- "description": "true if the account requires cleanup",
- "name": "iscleanuprequired",
- "type": "boolean"
- },
- {
- "description": "the total secondary storage space (in GiB) owned by account",
- "name": "secondarystoragetotal",
- "type": "float"
- },
- {
- "description": "the total memory (in MB) owned by account",
- "name": "memorytotal",
- "type": "long"
- },
- {
- "description": "the total number of public ip addresses this account can acquire",
- "name": "iplimit",
- "type": "string"
- },
- {
- "description": "true if account is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
- },
- {
- "description": "the network domain",
- "name": "networkdomain",
- "type": "string"
- },
- {
- "description": "the total number of projects the account can own",
- "name": "projectlimit",
- "type": "string"
- },
- {
- "description": "the total volume being used by this account",
- "name": "volumetotal",
- "type": "long"
- },
- {
- "description": "the total secondary storage space (in GiB) the account can own",
- "name": "secondarystoragelimit",
- "type": "string"
- },
- {
- "description": "the total number of templates which have been created by this account",
- "name": "templatetotal",
- "type": "long"
- },
- {
- "description": "the name of the account",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the total number of vpcs the account can own",
- "name": "vpclimit",
- "type": "string"
- },
- {
- "description": "the total number of virtual machines that can be deployed by this account",
- "name": "vmlimit",
- "type": "string"
- },
- {
- "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",
- "type": "string"
- },
- {
- "description": "the default zone of the account",
- "name": "defaultzoneid",
- "type": "string"
- },
- {
- "description": "the total number of templates which can be created by this account",
- "name": "templatelimit",
- "type": "string"
- },
- {
- "description": "name of the Domain the account belongs to",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the state of the account",
- "name": "state",
- "type": "string"
- },
- {
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
- },
- {
- "description": "the total volume available for this account",
- "name": "volumeavailable",
- "type": "string"
- },
- {
- "description": "the total number of snapshots which can be stored by this account",
- "name": "snapshotlimit",
- "type": "string"
- },
- {
- "description": "account type (admin, domain-admin, user)",
- "name": "accounttype",
- "type": "short"
- },
- {
- "description": "details for the account",
- "name": "accountdetails",
- "type": "map"
- },
- {
- "description": "the total primary storage space (in GiB) the account can own",
- "name": "primarystoragelimit",
- "type": "string"
- },
- {
- "description": "the total number of projects available for administration by this account",
- "name": "projectavailable",
- "type": "string"
- },
- {
- "description": "the total number of networks the account can own",
- "name": "networklimit",
- "type": "string"
- },
- {
- "description": "the total number of virtual machines running for this account",
- "name": "vmrunning",
- "type": "integer"
}
]
},
@@ -50200,13 +50745,6 @@
"name": "listDomains",
"params": [
{
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
- },
- {
"description": "comma separated list of domain details requested, value can be a list of [ all, resource, min]",
"length": 255,
"name": "details",
@@ -50221,19 +50759,11 @@
"type": "integer"
},
{
- "description": "List domain by domain ID.",
+ "description": "List domains by domain level.",
"length": 255,
- "name": "id",
- "related": "listDomainChildren,listDomains,listDomains",
+ "name": "level",
"required": false,
- "type": "uuid"
- },
- {
- "description": "List domain by domain name.",
- "length": 255,
- "name": "name",
- "required": false,
- "type": "string"
+ "type": "integer"
},
{
"description": "flag to display the resource icon for domains",
@@ -50243,9 +50773,9 @@
"type": "boolean"
},
{
- "description": "List domains by domain level.",
+ "description": "",
"length": 255,
- "name": "level",
+ "name": "pagesize",
"required": false,
"type": "integer"
},
@@ -50257,89 +50787,58 @@
"type": "boolean"
},
{
- "description": "",
+ "description": "List by keyword",
"length": 255,
- "name": "pagesize",
+ "name": "keyword",
"required": false,
- "type": "integer"
+ "type": "string"
+ },
+ {
+ "description": "List domain by domain name.",
+ "length": 255,
+ "name": "name",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "List domain by domain ID.",
+ "length": 255,
+ "name": "id",
+ "related": "listDomainChildren,listDomains,listDomains",
+ "required": false,
+ "type": "uuid"
}
],
"related": "listDomainChildren,listDomains",
"response": [
{
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
- },
- {
- "description": "the total number of projects the domain can own",
- "name": "projectlimit",
+ "description": "the path of the domain",
+ "name": "path",
"type": "string"
},
{
- "description": "the total secondary storage space (in GiB) owned by domain",
- "name": "secondarystoragetotal",
- "type": "float"
- },
- {
"description": "the date when this domain was created",
"name": "created",
"type": "date"
},
{
- "description": "the total number of virtual machines deployed by this domain",
- "name": "vmtotal",
- "type": "long"
+ "description": "the level of the domain",
+ "name": "level",
+ "type": "integer"
},
{
- "description": "the ID of the domain",
- "name": "id",
+ "description": "the total number of projects available for administration by this domain",
+ "name": "projectavailable",
"type": "string"
},
{
- "description": "the network domain",
- "name": "networkdomain",
+ "description": "the total number of snapshots which can be stored by this domain",
+ "name": "snapshotlimit",
"type": "string"
},
{
- "description": "the total number of networks owned by domain",
- "name": "networktotal",
- "type": "long"
- },
- {
- "description": "the total volume which can be used by this domain",
- "name": "volumelimit",
- "type": "string"
- },
- {
- "description": "the total number of public ip addresses available for this domain to acquire",
- "name": "ipavailable",
- "type": "string"
- },
- {
- "description": "the total number of public ip addresses this domain can acquire",
- "name": "iplimit",
- "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 available to be created for this domain",
- "name": "cpuavailable",
- "type": "string"
- },
- {},
- {
- "description": "the total number of virtual machines that can be deployed by this domain",
- "name": "vmlimit",
- "type": "string"
- },
- {
- "description": "the total number of vpcs the domain can own",
- "name": "vpclimit",
+ "description": "the state of the domain",
+ "name": "state",
"type": "string"
},
{
@@ -50348,38 +50847,43 @@
"type": "boolean"
},
{
- "description": "the total number of templates which can be created by this domain",
- "name": "templatelimit",
+ "description": "the total memory (in MB) the domain can own",
+ "name": "memorylimit",
"type": "string"
},
{
- "description": "the total number of templates available to be created by this domain",
- "name": "templateavailable",
+ "description": "the total secondary storage space (in GiB) available to be used for this domain",
+ "name": "secondarystorageavailable",
"type": "string"
},
{
- "description": "the domain ID of the parent domain",
- "name": "parentdomainid",
+ "description": "the network domain",
+ "name": "networkdomain",
"type": "string"
},
{
- "description": "whether the domain has one or more sub-domains",
- "name": "haschild",
- "type": "boolean"
- },
- {
- "description": "the total number of cpu cores owned by domain",
- "name": "cputotal",
+ "description": "the total volume being used by this domain",
+ "name": "volumetotal",
"type": "long"
},
{
- "description": "the total number of snapshots which can be stored by this domain",
- "name": "snapshotlimit",
+ "description": "the total volume which can be used by this domain",
+ "name": "volumelimit",
"type": "string"
},
{
- "description": "the total number of networks the domain can own",
- "name": "networklimit",
+ "description": "the total number of networks available to be created for this domain",
+ "name": "networkavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of vpcs available to be created for this domain",
+ "name": "vpcavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of templates which can be created by this domain",
+ "name": "templatelimit",
"type": "string"
},
{
@@ -50388,10 +50892,156 @@
"type": "integer"
},
{
+ "description": "the total secondary storage space (in GiB) the domain can own",
+ "name": "secondarystoragelimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of public ip addresses available for this domain to acquire",
+ "name": "ipavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total secondary storage space (in GiB) owned by domain",
+ "name": "secondarystoragetotal",
+ "type": "float"
+ },
+ {
+ "description": "the total number of cpu cores the domain can own",
+ "name": "cpulimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of templates available to be created by this domain",
+ "name": "templateavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of snapshots available for this domain",
+ "name": "snapshotavailable",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the total number of snapshots stored by this domain",
+ "name": "snapshottotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of cpu cores available to be created for this domain",
+ "name": "cpuavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total primary storage space (in GiB) the domain can own",
+ "name": "primarystoragelimit",
+ "type": "string"
+ },
+ {
+ "description": "the domain name of the parent domain",
+ "name": "parentdomainname",
+ "type": "string"
+ },
+ {
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "description": "the name of the domain",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the total number of cpu cores owned by domain",
+ "name": "cputotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of networks the domain can own",
+ "name": "networklimit",
+ "type": "string"
+ },
+ {
+ "description": "details for the domain",
+ "name": "domaindetails",
+ "type": "map"
+ },
+ {},
+ {
+ "description": "the total volume available for this domain",
+ "name": "volumeavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of vpcs the domain can own",
+ "name": "vpclimit",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the total number of virtual machines that can be deployed by this domain",
+ "name": "vmlimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of virtual machines available for this domain to acquire",
+ "name": "vmavailable",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID of the parent domain",
+ "name": "parentdomainid",
+ "type": "string"
+ },
+ {
+ "description": "the total number of projects the domain can own",
+ "name": "projectlimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of virtual machines deployed by this domain",
+ "name": "vmtotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of public ip addresses this domain can acquire",
+ "name": "iplimit",
+ "type": "string"
+ },
+ {
+ "description": "whether the domain has one or more sub-domains",
+ "name": "haschild",
+ "type": "boolean"
+ },
+ {
+ "description": "the total number of vpcs owned by domain",
+ "name": "vpctotal",
+ "type": "long"
+ },
+ {
+ "description": "the total primary storage space (in GiB) available to be used for this domain",
+ "name": "primarystorageavailable",
+ "type": "string"
+ },
+ {
"description": "the total number of templates which have been created by this domain",
"name": "templatetotal",
"type": "long"
},
+ {
+ "description": "the total number of public ip addresses allocated for this domain",
+ "name": "iptotal",
+ "type": "long"
+ },
{},
{
"description": "the total memory (in MB) available to be created for this domain",
@@ -50399,73 +51049,13 @@
"type": "string"
},
{
- "description": "the total primary storage space (in GiB) available to be used for this domain",
- "name": "primarystorageavailable",
- "type": "string"
- },
- {
- "description": "the total number of cpu cores the domain can own",
- "name": "cpulimit",
- "type": "string"
- },
- {
- "description": "the total number of vpcs owned by domain",
- "name": "vpctotal",
- "type": "long"
- },
- {
- "description": "the state of the domain",
- "name": "state",
- "type": "string"
- },
- {
- "description": "the level of the domain",
- "name": "level",
- "type": "integer"
- },
- {
- "description": "the total number of public ip addresses allocated for this domain",
- "name": "iptotal",
- "type": "long"
- },
- {
- "description": "the total secondary storage space (in GiB) the domain can own",
- "name": "secondarystoragelimit",
- "type": "string"
- },
- {
- "description": "the domain name of the parent domain",
- "name": "parentdomainname",
- "type": "string"
- },
- {
"description": "the total memory (in MB) owned by domain",
"name": "memorytotal",
"type": "long"
},
{
- "description": "the total number of snapshots stored by this domain",
- "name": "snapshottotal",
- "type": "long"
- },
- {
- "description": "the total secondary storage space (in GiB) available to be used for this domain",
- "name": "secondarystorageavailable",
- "type": "string"
- },
- {
- "description": "the total memory (in MB) the domain can own",
- "name": "memorylimit",
- "type": "string"
- },
- {
- "description": "the total primary storage space (in GiB) the domain can own",
- "name": "primarystoragelimit",
- "type": "string"
- },
- {
- "description": "the total volume being used by this domain",
- "name": "volumetotal",
+ "description": "the total number of networks owned by domain",
+ "name": "networktotal",
"type": "long"
},
{
@@ -50474,54 +51064,9 @@
"type": "long"
},
{
- "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": "details for the domain",
- "name": "domaindetails",
- "type": "map"
- },
- {
- "description": "the path of the domain",
- "name": "path",
- "type": "string"
- },
- {
- "description": "the name of the domain",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the total number of networks available to be created for this domain",
- "name": "networkavailable",
- "type": "string"
- },
- {
- "description": "the total number of virtual machines available for this domain to acquire",
- "name": "vmavailable",
- "type": "string"
- },
- {
- "description": "the total volume available for this domain",
- "name": "volumeavailable",
- "type": "string"
- },
- {
- "description": "the total number of projects available for administration by this domain",
- "name": "projectavailable",
- "type": "string"
- },
- {
- "description": "the total number of snapshots available for this domain",
- "name": "snapshotavailable",
- "type": "string"
}
]
},
@@ -50531,27 +51076,6 @@
"name": "updateNetwork",
"params": [
{
- "description": "Setting this to true will cause a forced network update,",
- "length": 255,
- "name": "forced",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "CIDR for guest VMs, CloudStack allocates IPs to guest VMs only from this CIDR",
- "length": 255,
- "name": "guestvmcidr",
- "required": false,
- "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": "the ID of the network",
"length": 255,
"name": "id",
@@ -50560,9 +51084,9 @@
"type": "uuid"
},
{
- "description": "the new name for the network",
+ "description": "CIDR for guest VMs, CloudStack allocates IPs to guest VMs only from this CIDR",
"length": 255,
- "name": "name",
+ "name": "guestvmcidr",
"required": false,
"type": "string"
},
@@ -50574,6 +51098,28 @@
"type": "string"
},
{
+ "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only",
+ "length": 255,
+ "name": "customid",
+ "required": false,
+ "since": "4.4",
+ "type": "string"
+ },
+ {
+ "description": "an optional field, whether to the display the network to the end user or not.",
+ "length": 255,
+ "name": "displaynetwork",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "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": "network domain",
"length": 255,
"name": "networkdomain",
@@ -50581,11 +51127,17 @@
"type": "string"
},
{
- "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only",
+ "description": "Setting this to true will cause a forced network update,",
"length": 255,
- "name": "customid",
+ "name": "forced",
"required": false,
- "since": "4.4",
+ "type": "boolean"
+ },
+ {
+ "description": "the new name for the network",
+ "length": 255,
+ "name": "name",
+ "required": false,
"type": "string"
},
{
@@ -50604,13 +51156,6 @@
"type": "uuid"
},
{
- "description": "an optional field, whether to the display the network to the end user or not.",
- "length": 255,
- "name": "displaynetwork",
- "required": false,
- "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",
"length": 255,
"name": "updateinsequence",
@@ -50621,69 +51166,100 @@
"related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks",
"response": [
{
- "description": "true network requires restart",
- "name": "restartrequired",
+ "description": "If the network has redundant routers enabled",
+ "name": "redundantrouter",
"type": "boolean"
},
{
- "description": "state of the network",
- "name": "state",
+ "description": "the total number of network traffic bytes sent",
+ "name": "sentbytes",
+ "type": "long"
+ },
+ {
+ "description": "VPC the network belongs to",
+ "name": "vpcid",
"type": "string"
},
{
+ "description": "the network's gateway",
+ "name": "gateway",
+ "type": "string"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the date this network was created",
+ "name": "created",
+ "type": "date"
+ },
+ {},
+ {
"description": "the network's netmask",
"name": "netmask",
"type": "string"
},
{
- "description": "display text of the network offering the network is created from",
- "name": "networkofferingdisplaytext",
- "type": "string"
- },
- {
- "description": "broadcast uri of the network. This parameter is visible to ROOT admins only",
- "name": "broadcasturi",
- "type": "string"
- },
- {
- "description": "the type of the network",
- "name": "type",
- "type": "string"
- },
- {
- "description": "true if network offering is ip conserve mode enabled",
- "name": "networkofferingconservemode",
- "type": "boolean"
- },
- {
- "description": "the project name of the address",
- "name": "project",
- "type": "string"
- },
- {
"description": "list networks that are persistent",
"name": "ispersistent",
"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": "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": "zone id of the network",
+ "name": "zoneid",
"type": "string"
},
{
- "description": "the id of the network",
- "name": "id",
+ "description": "the gateway of IPv6 network",
+ "name": "ip6gateway",
"type": "string"
},
{
- "description": "the project id of the ipaddress",
- "name": "projectid",
+ "description": "an optional field, whether to the display the network to the end user or not.",
+ "name": "displaynetwork",
+ "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": "the second DNS for the network",
+ "name": "dns2",
+ "type": "string"
+ },
+ {
+ "description": "state of the network",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "broadcast uri of the network. This parameter is visible to ROOT admins only",
+ "name": "broadcasturi",
+ "type": "string"
+ },
+ {
+ "description": "the name of the zone the network belongs to",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "The vlan of the network. This parameter is visible to ROOT admins only",
+ "name": "vlan",
+ "type": "string"
},
{
"description": "the displaytext of the network",
@@ -50691,56 +51267,64 @@
"type": "string"
},
{
+ "description": "true if network offering is ip conserve mode enabled",
+ "name": "networkofferingconservemode",
+ "type": "boolean"
+ },
+ {
+ "description": "true if network is system, false otherwise",
+ "name": "issystem",
+ "type": "boolean"
+ },
+ {
+ "description": "true network requires restart",
+ "name": "restartrequired",
+ "type": "boolean"
+ },
+ {
+ "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans",
+ "name": "zonesnetworkspans",
+ "type": "set"
+ },
+ {
+ "description": "the project name of the address",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "availability of the network offering the network is created from",
+ "name": "networkofferingavailability",
+ "type": "string"
+ },
+ {
+ "description": "the cidr of IPv6 network",
+ "name": "ip6cidr",
+ "type": "string"
+ },
+ {
+ "description": "acl type - access type to the network",
+ "name": "acltype",
+ "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 list of services",
"name": "service",
"response": [
{
- "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": "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": "state of the network provider",
- "name": "state",
- "type": "string"
- }
- ],
- "type": "list"
- },
- {
"description": "the list of capabilities",
"name": "capability",
"response": [
{
+ "description": "can this service capability value can be choosable while creatine network offerings",
+ "name": "canchooseservicecapability",
+ "type": "boolean"
+ },
+ {
"description": "the capability name",
"name": "name",
"type": "string"
@@ -50749,11 +51333,6 @@
"description": "the capability value",
"name": "value",
"type": "string"
- },
- {
- "description": "can this service capability value can be choosable while creatine network offerings",
- "name": "canchooseservicecapability",
- "type": "boolean"
}
],
"type": "list"
@@ -50762,185 +51341,70 @@
"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": "uuid of the network provider",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the destination physical network",
+ "name": "destinationphysicalnetworkid",
+ "type": "string"
+ },
+ {
+ "description": "services for this provider",
+ "name": "servicelist",
+ "type": "list"
+ },
+ {
+ "description": "the provider name",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "true if individual services can be enabled/disabled",
+ "name": "canenableindividualservice",
+ "type": "boolean"
+ },
+ {
+ "description": "the physical network this belongs to",
+ "name": "physicalnetworkid",
+ "type": "string"
+ }
+ ],
+ "type": "list"
}
],
"type": "list"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the network domain",
+ "name": "networkdomain",
"type": "string"
},
{
- "description": "the traffic type of the network",
- "name": "traffictype",
- "type": "string"
- },
- {
- "description": "the owner of the network",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the total number of network traffic bytes sent",
- "name": "sentbytes",
- "type": "long"
- },
- {
- "description": "the name of the zone the network belongs to",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "If the network has redundant routers enabled",
- "name": "redundantrouter",
- "type": "boolean"
- },
- {
- "description": "availability of the network offering the network is created from",
- "name": "networkofferingavailability",
- "type": "string"
- },
- {
- "description": "related to what other network configuration",
- "name": "related",
- "type": "string"
- },
- {
- "description": "zone id of the network",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "Broadcast domain type of the network",
- "name": "broadcastdomaintype",
- "type": "string"
- },
- {
- "description": "the physical network id",
- "name": "physicalnetworkid",
- "type": "string"
- },
- {
- "description": "The external id of the network",
- "name": "externalid",
- "type": "string"
- },
- {
- "description": "the domain id of the network owner",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR",
- "name": "cidr",
- "type": "string"
- },
- {
- "description": "the first DNS for the network",
- "name": "dns1",
- "type": "string"
- },
- {
- "description": "true if users from subdomains can access the domain level network",
- "name": "subdomainaccess",
- "type": "boolean"
- },
- {
- "description": "the gateway of IPv6 network",
- "name": "ip6gateway",
- "type": "string"
- },
- {},
- {
- "description": "the network's gateway",
- "name": "gateway",
- "type": "string"
- },
- {
- "description": "the total number of network traffic bytes received",
- "name": "receivedbytes",
- "type": "long"
- },
- {
- "description": "true if network supports specifying ip ranges, false otherwise",
- "name": "specifyipranges",
- "type": "boolean"
- },
- {
- "description": "name of the network offering the network is created from",
- "name": "networkofferingname",
- "type": "string"
- },
- {
- "description": "The vlan of the network. This parameter is visible to ROOT admins only",
- "name": "vlan",
- "type": "string"
- },
- {
- "description": "list networks available for vm deployment",
- "name": "canusefordeploy",
- "type": "boolean"
- },
- {
- "description": "ACL name associated with the VPC network",
- "name": "aclname",
- "type": "string"
- },
- {
- "description": "true if network is system, false otherwise",
- "name": "issystem",
- "type": "boolean"
- },
- {
- "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",
"name": "name",
"type": "string"
},
{
- "description": "the date this network was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "network offering id the network is created from",
- "name": "networkofferingid",
- "type": "string"
- },
- {
- "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes",
- "name": "reservediprange",
- "type": "string"
- },
- {
"description": "ACL Id associated with the VPC network",
"name": "aclid",
"type": "string"
},
{
- "description": "VPC the network belongs to",
- "name": "vpcid",
- "type": "string"
- },
- {},
- {
- "description": "acl type - access type to the network",
- "name": "acltype",
- "type": "string"
- },
- {
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
- },
- {
- "description": "the cidr of IPv6 network",
- "name": "ip6cidr",
+ "description": "the traffic type of the network",
+ "name": "traffictype",
"type": "string"
},
{
@@ -50949,8 +51413,38 @@
"type": "boolean"
},
{
- "description": "Name of the VPC to which this network belongs",
- "name": "vpcname",
+ "description": "the owner of the network",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the project id of the ipaddress",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the domain id of the network owner",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the physical network id",
+ "name": "physicalnetworkid",
+ "type": "string"
+ },
+ {
+ "description": "the first DNS for the network",
+ "name": "dns1",
"type": "string"
},
{
@@ -50959,13 +51453,53 @@
"type": "boolean"
},
{
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
+ "description": "ACL name associated with the VPC network",
+ "name": "aclname",
+ "type": "string"
+ },
+ {
+ "description": "the type of the network",
+ "name": "type",
+ "type": "string"
+ },
+ {
+ "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR",
+ "name": "cidr",
+ "type": "string"
+ },
+ {
+ "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes",
+ "name": "reservediprange",
+ "type": "string"
+ },
+ {
+ "description": "true if users from subdomains can access the domain level network",
+ "name": "subdomainaccess",
"type": "boolean"
},
{
- "description": "the domain name of the network owner",
- "name": "domain",
+ "description": "the details of the network",
+ "name": "details",
+ "type": "map"
+ },
+ {
+ "description": "Broadcast domain type of the network",
+ "name": "broadcastdomaintype",
+ "type": "string"
+ },
+ {
+ "description": "Name of the VPC to which this network belongs",
+ "name": "vpcname",
+ "type": "string"
+ },
+ {
+ "description": "the id of the network",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "name of the network offering the network is created from",
+ "name": "networkofferingname",
"type": "string"
},
{
@@ -50973,38 +51507,33 @@
"name": "tags",
"response": [
{
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
"description": "the project name where tag belongs to",
"name": "project",
"type": "string"
},
{
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
"description": "the domain associated with the tag",
"name": "domain",
"type": "string"
},
{
- "description": "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",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
"type": "string"
},
{
@@ -51018,32 +51547,48 @@
"type": "string"
},
{
- "description": "the account associated with the tag",
- "name": "account",
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
"type": "string"
}
],
"type": "list"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "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 DNS for the network",
- "name": "dns2",
+ "description": "related to what other network configuration",
+ "name": "related",
"type": "string"
},
{
- "description": "the network domain",
- "name": "networkdomain",
+ "description": "display text of the network offering the network is created from",
+ "name": "networkofferingdisplaytext",
"type": "string"
+ },
+ {
+ "description": "the domain name of the network owner",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "description": "The external id of the network",
+ "name": "externalid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the total number of network traffic bytes received",
+ "name": "receivedbytes",
+ "type": "long"
}
]
},
@@ -51055,26 +51600,26 @@
"related": "",
"response": [
{},
+ {},
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
{
"description": "usage type",
"name": "usagetypeid",
"type": "integer"
},
{
- "description": "description of usage type",
- "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": "description of usage type",
+ "name": "description",
+ "type": "string"
}
]
},
@@ -51109,11 +51654,7 @@
}
],
"response": [
- {
- "description": "true if operation is executed successfully",
- "name": "success",
- "type": "boolean"
- },
+ {},
{},
{
"description": "the current status of the latest async job acting on this object",
@@ -51130,7 +51671,11 @@
"name": "displaytext",
"type": "string"
},
- {}
+ {
+ "description": "true if operation is executed successfully",
+ "name": "success",
+ "type": "boolean"
+ }
]
},
{
@@ -51139,6 +51684,29 @@
"name": "listNetworkACLLists",
"params": [
{
+ "description": "list objects by project",
+ "length": 255,
+ "name": "projectid",
+ "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "list only resources belonging to the domain specified",
+ "length": 255,
+ "name": "domainid",
+ "related": "listDomainChildren,listDomains",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
+ "length": 255,
+ "name": "isrecursive",
+ "required": false,
+ "type": "boolean"
+ },
+ {
"description": "List by keyword",
"length": 255,
"name": "keyword",
@@ -51146,6 +51714,43 @@
"type": "string"
},
{
+ "description": "list network ACLs by specified name",
+ "length": 255,
+ "name": "name",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter",
+ "length": 255,
+ "name": "fordisplay",
+ "required": false,
+ "since": "4.4",
+ "type": "boolean"
+ },
+ {
+ "description": "Lists network ACL with the specified ID.",
+ "length": 255,
+ "name": "id",
+ "related": "createNetworkACLList,listNetworkACLLists",
+ "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 network ACLs by network ID",
"length": 255,
"name": "networkid",
@@ -51154,28 +51759,6 @@
"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",
- "length": 255,
- "name": "listall",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "list only resources belonging to the domain specified",
- "length": 255,
- "name": "domainid",
- "related": "listDomainChildren,listDomains",
- "required": false,
- "type": "uuid"
- },
- {
"description": "list network ACLs by VPC ID",
"length": 255,
"name": "vpcid",
@@ -51184,20 +51767,6 @@
"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.",
- "length": 255,
- "name": "isrecursive",
- "required": false,
- "type": "boolean"
- },
- {
"description": "",
"length": 255,
"name": "pagesize",
@@ -51205,75 +51774,51 @@
"type": "integer"
},
{
- "description": "list objects by project",
+ "description": "If set to false, list only 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": "projectid",
- "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject",
+ "name": "listall",
"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": "list network ACLs by specified name",
- "length": 255,
- "name": "name",
- "required": false,
- "type": "string"
- },
- {
- "description": "Lists network ACL with the specified ID.",
- "length": 255,
- "name": "id",
- "related": "createNetworkACLList,listNetworkACLLists",
- "required": false,
- "type": "uuid"
}
],
"related": "createNetworkACLList",
"response": [
{
+ "description": "is ACL for display to the regular user",
+ "name": "fordisplay",
+ "type": "boolean"
+ },
+ {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
- {},
- {
- "description": "Id of the VPC this ACL is associated with",
- "name": "vpcid",
- "type": "string"
- },
{
"description": "the Name of the ACL",
"name": "name",
"type": "string"
},
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
{},
{
- "description": "is ACL for display to the regular user",
- "name": "fordisplay",
- "type": "boolean"
+ "description": "Description of the ACL",
+ "name": "description",
+ "type": "string"
+ },
+ {
+ "description": "Id of the VPC this ACL is associated with",
+ "name": "vpcid",
+ "type": "string"
},
{
"description": "the ID of the ACL",
"name": "id",
"type": "string"
},
+ {},
{
- "description": "Description of the ACL",
- "name": "description",
- "type": "string"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
}
]
},
@@ -51294,34 +51839,34 @@
"related": "revertSnapshot",
"response": [
{
- "description": "ID of the snapshot",
- "name": "id",
- "type": "string"
- },
- {},
- {
- "description": "display name of the os on volume",
- "name": "osdisplayname",
- "type": "string"
- },
- {
- "description": "the domain ID of the snapshot's account",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
+ "description": "physical size of backedup snapshot on image store",
+ "name": "physicalsize",
+ "type": "long"
},
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
+ {},
{
- "description": "name of the snapshot",
- "name": "name",
+ "description": "ID of the disk volume",
+ "name": "volumeid",
+ "type": "string"
+ },
+ {
+ "description": " the date the snapshot was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the type of the snapshot",
+ "name": "snapshottype",
+ "type": "string"
+ },
+ {
+ "description": "the domain name of the snapshot's account",
+ "name": "domain",
"type": "string"
},
{
@@ -51329,6 +51874,21 @@
"name": "tags",
"response": [
{
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
"description": "tag key name",
"name": "key",
"type": "string"
@@ -51339,8 +51899,8 @@
"type": "string"
},
{
- "description": "the account associated with the tag",
- "name": "account",
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
"type": "string"
},
{
@@ -51349,8 +51909,8 @@
"type": "string"
},
{
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
+ "description": "id of the resource",
+ "name": "resourceid",
"type": "string"
},
{
@@ -51362,54 +51922,59 @@
"description": "customer associated with the tag",
"name": "customer",
"type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
}
],
"type": "set"
},
{
- "description": "ID of the disk volume",
- "name": "volumeid",
- "type": "string"
- },
- {
- "description": "physical size of backedup snapshot on image store",
- "name": "physicalsize",
- "type": "long"
- },
- {
- "description": "id of the os on volume",
- "name": "ostypeid",
- "type": "string"
- },
- {
"description": "virtual size of backedup snapshot on image store",
"name": "virtualsize",
"type": "long"
},
{},
{
- "description": " the date the snapshot was created",
- "name": "created",
- "type": "date"
+ "description": "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": "type of the disk volume",
+ "name": "volumetype",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the snapshot",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID of the snapshot's account",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "valid types are hourly, daily, weekly, monthy, template, and none.",
+ "name": "intervaltype",
+ "type": "string"
+ },
+ {
+ "description": "id of the availability zone",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "valid location types are primary and secondary.",
+ "name": "locationtype",
+ "type": "string"
+ },
+ {
+ "description": "id of the os on volume",
+ "name": "ostypeid",
+ "type": "string"
+ },
+ {
+ "description": "display name of the os on volume",
+ "name": "osdisplayname",
"type": "string"
},
{
@@ -51423,23 +51988,23 @@
"type": "state"
},
{
- "description": "type of the disk volume",
- "name": "volumetype",
- "type": "string"
- },
- {
- "description": "indicates whether the underlying storage supports reverting the volume to this snapshot",
- "name": "revertable",
- "type": "boolean"
- },
- {
"description": "name of the disk volume",
"name": "volumename",
"type": "string"
},
{
- "description": "the type of the snapshot",
- "name": "snapshottype",
+ "description": "name of the snapshot",
+ "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 snapshot",
+ "name": "projectid",
"type": "string"
},
{
@@ -51448,28 +52013,8 @@
"type": "boolean"
},
{
- "description": "the project id of the snapshot",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "valid types are hourly, daily, weekly, monthy, template, and none.",
- "name": "intervaltype",
- "type": "string"
- },
- {
- "description": "valid location types are primary and secondary.",
- "name": "locationtype",
- "type": "string"
- },
- {
- "description": "id of the availability zone",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the account associated with the snapshot",
- "name": "account",
+ "description": "ID of the snapshot",
+ "name": "id",
"type": "string"
}
]
@@ -51489,17 +52034,17 @@
}
],
"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 UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
@@ -51519,14 +52064,6 @@
"name": "updateVpnGateway",
"params": [
{
- "description": "id of customer gateway",
- "length": 255,
- "name": "id",
- "related": "createVpnGateway,listVpnGateways,updateVpnGateway",
- "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",
@@ -51535,6 +52072,14 @@
"type": "string"
},
{
+ "description": "id of customer gateway",
+ "length": 255,
+ "name": "id",
+ "related": "createVpnGateway,listVpnGateways,updateVpnGateway",
+ "required": true,
+ "type": "uuid"
+ },
+ {
"description": "an optional field, whether to the display the vpn to the end user or not",
"length": 255,
"name": "fordisplay",
@@ -51546,55 +52091,19 @@
"related": "createVpnGateway,listVpnGateways",
"response": [
{
- "description": "the domain name of the owner",
- "name": "domain",
+ "description": "the vpn gateway ID",
+ "name": "id",
"type": "string"
},
{},
{
- "description": "the date and time the host was removed",
- "name": "removed",
- "type": "date"
- },
- {
- "description": "the owner",
- "name": "account",
- "type": "string"
- },
- {
"description": "is vpn gateway for display to the regular user",
"name": "fordisplay",
"type": "boolean"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the project id",
- "name": "projectid",
- "type": "string"
- },
- {},
- {
- "description": "the vpn gateway ID",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the project name",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the domain id of the owner",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the owner",
+ "name": "account",
"type": "string"
},
{
@@ -51611,6 +52120,42 @@
"description": "the vpc name of this gateway",
"name": "vpcname",
"type": "string"
+ },
+ {},
+ {
+ "description": "the date and time the host was removed",
+ "name": "removed",
+ "type": "date"
+ },
+ {
+ "description": "the domain name of the owner",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the project name",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the project id",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the domain id of the owner",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting 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"
@@ -51631,8 +52176,8 @@
],
"response": [
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "any text associated with the success or failure",
+ "name": "displaytext",
"type": "string"
},
{
@@ -51645,12 +52190,12 @@
"name": "jobstatus",
"type": "integer"
},
+ {},
{
- "description": "any text associated with the success or failure",
- "name": "displaytext",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
- {},
{}
]
},
@@ -51660,17 +52205,10 @@
"name": "deleteSecurityGroup",
"params": [
{
- "description": "The ID of the security group. Mutually exclusive with id parameter",
+ "description": "the project of the security group",
"length": 255,
- "name": "name",
- "required": false,
- "type": "string"
- },
- {
- "description": "the domain ID of account owning the security group",
- "length": 255,
- "name": "domainid",
- "related": "listDomainChildren,listDomains",
+ "name": "projectid",
+ "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject",
"required": false,
"type": "uuid"
},
@@ -51683,6 +52221,13 @@
"type": "uuid"
},
{
+ "description": "The ID of the security group. Mutually exclusive with id parameter",
+ "length": 255,
+ "name": "name",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "the account of the security group. Must be specified with domain ID",
"length": 255,
"name": "account",
@@ -51690,37 +52235,37 @@
"type": "string"
},
{
- "description": "the project of the security group",
+ "description": "the domain ID of account owning the security group",
"length": 255,
- "name": "projectid",
- "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject",
+ "name": "domainid",
+ "related": "listDomainChildren,listDomains",
"required": false,
"type": "uuid"
}
],
"response": [
- {
- "description": "true if operation is executed successfully",
- "name": "success",
- "type": "boolean"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
{},
+ {},
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
{
"description": "any text associated with the success or failure",
"name": "displaytext",
"type": "string"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
- {}
+ {
+ "description": "true if operation is executed successfully",
+ "name": "success",
+ "type": "boolean"
+ }
]
},
{
@@ -51729,14 +52274,6 @@
"name": "migrateVirtualMachine",
"params": [
{
- "description": "the ID of the virtual machine",
- "length": 255,
- "name": "virtualmachineid",
- "related": "migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance",
- "required": true,
- "type": "uuid"
- },
- {
"description": "Automatically select a destination host which do not require storage migration, if hostId and storageId are not specified. false by default",
"length": 255,
"name": "autoselect",
@@ -51745,6 +52282,14 @@
"type": "boolean"
},
{
+ "description": "the ID of the virtual machine",
+ "length": 255,
+ "name": "virtualmachineid",
+ "related": "migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance",
+ "required": true,
+ "type": "uuid"
+ },
+ {
"description": "Destination Host ID to migrate VM to.",
"length": 255,
"name": "hostid",
@@ -51764,39 +52309,223 @@
"related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance",
"response": [
{
- "description": "the name of the host for the virtual machine",
- "name": "hostname",
+ "description": "ssh key-pair",
+ "name": "keypair",
"type": "string"
},
{
- "description": "the ID of the backup offering of the virtual machine",
- "name": "backupofferingid",
+ "description": "the name of the backup offering of the virtual machine",
+ "name": "backupofferingname",
"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": "OS type id of the vm",
- "name": "ostypeid",
- "type": "string"
+ "description": "the list of nics associated with vm",
+ "name": "nic",
+ "response": [
+ {
+ "description": "the gateway of IPv6 network",
+ "name": "ip6gateway",
+ "type": "string"
+ },
+ {
+ "description": "the isolated private VLAN type if available",
+ "name": "isolatedpvlantype",
+ "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 broadcast uri of the nic",
+ "name": "broadcasturi",
+ "type": "string"
+ },
+ {
+ "description": "Id of the vm to which the nic belongs",
+ "name": "virtualmachineid",
+ "type": "string"
+ },
+ {
+ "description": "the cidr of IPv6 network",
+ "name": "ip6cidr",
+ "type": "string"
+ },
+ {
+ "description": "the IPv6 address of network",
+ "name": "ip6address",
+ "type": "string"
+ },
+ {
+ "description": "the isolated private VLAN if available",
+ "name": "isolatedpvlan",
+ "type": "integer"
+ },
+ {
+ "description": "the ip address of the nic",
+ "name": "ipaddress",
+ "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 extra dhcp options on the nic",
+ "name": "extradhcpoption",
+ "type": "list"
+ },
+ {
+ "description": "Type of adapter if available",
+ "name": "adaptertype",
+ "type": "string"
+ },
+ {
+ "description": "the isolation uri of the nic",
+ "name": "isolationuri",
+ "type": "string"
+ },
+ {
+ "description": "the name of the corresponding network",
+ "name": "networkname",
+ "type": "string"
+ },
+ {
+ "description": "the traffic type of the nic",
+ "name": "traffictype",
+ "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 gateway of the nic",
+ "name": "gateway",
+ "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": "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 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"
+ }
+ ],
+ "type": "set"
},
{
- "description": "Guest vm Boot Type",
- "name": "boottype",
- "type": "string"
+ "description": "the write (bytes) of disk on the vm",
+ "name": "diskkbswrite",
+ "type": "long"
},
{
- "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": "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 description of the affinity group",
+ "name": "description",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID of the affinity group",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the type of the affinity group",
+ "name": "type",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the affinity group",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the domain name of the affinity group",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the project ID of the affinity group",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the affinity group",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the account owning the affinity group",
+ "name": "account",
+ "type": "string"
+ }
+ ],
+ "type": "set"
},
{
- "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",
@@ -51804,98 +52533,27 @@
"type": "string"
},
{
- "description": "the user's ID who deployed the virtual machine",
- "name": "userid",
- "type": "string"
- },
- {
- "description": "public IP address id associated with vm via Static nat rule",
- "name": "publicip",
- "type": "string"
- },
- {
"description": "the account associated with the virtual machine",
"name": "account",
"type": "string"
},
{
- "description": "the name of the disk offering of the virtual machine",
- "name": "diskofferingname",
+ "description": "the ID of the service offering of the virtual machine",
+ "name": "serviceofferingid",
"type": "string"
},
{
- "description": "the ID of the domain in which the virtual machine exists",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "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 name of the service offering of the virtual machine",
- "name": "serviceofferingname",
- "type": "string"
- },
- {
- "description": "the virtual network for the service offering",
- "name": "forvirtualnetwork",
- "type": "boolean"
- },
- {
- "description": "device ID of the root volume",
- "name": "rootdeviceid",
+ "description": "the memory used by the vm",
+ "name": "memorykbs",
"type": "long"
},
{
- "description": "the ID of the availablility zone for the virtual machine",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the read (io) of disk on the vm",
- "name": "diskioread",
- "type": "long"
- },
- {
- "description": "the vgpu type used by the virtual machine",
- "name": "vgpu",
- "type": "string"
- },
- {
- "description": "the outgoing network traffic on the host",
- "name": "networkkbswrite",
- "type": "long"
- },
- {
- "description": "OS name of the vm",
- "name": "osdisplayname",
- "type": "string"
- },
- {
- "description": " an alternate display text of the template for the virtual machine",
- "name": "templatedisplaytext",
- "type": "string"
- },
- {},
- {
- "description": "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": "tag value",
- "name": "value",
+ "description": "the account associated with the tag",
+ "name": "account",
"type": "string"
},
{
@@ -51914,13 +52572,8 @@
"type": "string"
},
{
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
+ "description": "tag value",
+ "name": "value",
"type": "string"
},
{
@@ -51929,8 +52582,8 @@
"type": "string"
},
{
- "description": "the account associated with the tag",
- "name": "account",
+ "description": "id of the resource",
+ "name": "resourceid",
"type": "string"
},
{
@@ -51939,138 +52592,21 @@
"type": "string"
},
{
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "list of affinity groups associated with the virtual machine",
- "name": "affinitygroup",
- "response": [
- {
- "description": "the ID of the affinity group",
- "name": "id",
+ "description": "customer associated with the tag",
+ "name": "customer",
"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 name of the affinity group",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the domain name of the affinity group",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the description of the affinity group",
- "name": "description",
- "type": "string"
- },
- {
- "description": "the project name of the affinity group",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the project ID of the affinity group",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the domain ID of the affinity group",
+ "description": "the ID of the domain associated with the tag",
"name": "domainid",
"type": "string"
- },
- {
- "description": "the type of the affinity group",
- "name": "type",
- "type": "string"
}
],
"type": "set"
},
{
- "description": "the memory allocated for the virtual machine",
- "name": "memory",
- "type": "integer"
- },
- {
- "description": "the project id of the vm",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "device type of the root volume",
- "name": "rootdevicetype",
- "type": "string"
- },
- {
- "description": "the state of the virtual machine",
- "name": "state",
- "type": "string"
- },
- {
- "description": "List of read-only Vm details as comma separated string.",
- "name": "readonlydetails",
- "type": "string"
- },
- {
- "description": "ssh key-pair",
- "name": "keypair",
- "type": "string"
- },
- {
- "description": "the name of the availability zone for the virtual machine",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "the user's name who deployed the virtual machine",
- "name": "username",
- "type": "string"
- },
- {
- "description": "true if high-availability is enabled, false otherwise",
- "name": "haenable",
- "type": "boolean"
- },
- {
- "description": "the incoming network traffic on the vm",
- "name": "networkkbsread",
- "type": "long"
- },
- {
- "description": "instance name of the user vm; this parameter is returned to the ROOT admin only",
- "name": "instancename",
- "type": "string"
- },
- {
- "description": "the total number of network traffic bytes sent",
- "name": "sentbytes",
- "type": "long"
- },
- {
- "description": "the name of the ISO attached to the virtual machine",
- "name": "isoname",
- "type": "string"
- },
- {
- "description": "the read (bytes) of disk on the vm",
- "name": "diskkbsread",
+ "description": "the total number of network traffic bytes received",
+ "name": "receivedbytes",
"type": "long"
},
{
@@ -52079,18 +52615,13 @@
"type": "map"
},
{
- "description": "the target memory in vm",
- "name": "memorytargetkbs",
- "type": "long"
+ "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": "Os type ID of the virtual machine",
- "name": "guestosid",
+ "description": "List of read-only Vm details as comma separated string.",
+ "name": "readonlydetails",
"type": "string"
},
{
@@ -52099,48 +52630,18 @@
"type": "string"
},
{
- "description": "the amount of the vm's CPU currently used",
- "name": "cpuused",
+ "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 pool type of the virtual machine",
- "name": "pooltype",
- "type": "string"
- },
- {
- "description": "the group name of the virtual machine",
- "name": "group",
- "type": "string"
- },
- {
- "description": "the ID of the disk offering of the virtual machine",
- "name": "diskofferingid",
- "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 speed of each cpu",
- "name": "cpuspeed",
- "type": "integer"
- },
- {
- "description": "public IP address id associated with vm via Static nat rule",
- "name": "publicipid",
- "type": "string"
- },
- {
- "description": "the ID of the service offering of the virtual machine",
- "name": "serviceofferingid",
+ "description": "the name of the virtual machine",
+ "name": "name",
"type": "string"
},
{
@@ -52149,14 +52650,39 @@
"type": "integer"
},
{
- "description": "the internal memory that's free in vm or zero if it can not be calculated",
- "name": "memoryintfreekbs",
- "type": "long"
+ "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 group name of the virtual machine",
+ "name": "group",
+ "type": "string"
+ },
+ {
+ "description": "the group ID of the virtual machine",
+ "name": "groupid",
+ "type": "string"
+ },
+ {
+ "description": "the password (if exists) of the virtual machine",
+ "name": "password",
+ "type": "string"
+ },
+ {
+ "description": "the state of the virtual machine",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "public IP address id associated with vm via Static nat rule",
+ "name": "publicip",
+ "type": "string"
+ },
+ {
+ "description": "public IP address id associated with vm via Static nat rule",
+ "name": "publicipid",
+ "type": "string"
},
{
"description": "the name of the domain in which the virtual machine exists",
@@ -52164,37 +52690,374 @@
"type": "string"
},
{
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
+ "description": "the ID of the virtual machine",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the read (io) of disk on the vm",
+ "name": "diskioread",
+ "type": "long"
+ },
+ {
+ "description": "the date when this virtual machine was updated last time",
+ "name": "lastupdated",
+ "type": "date"
+ },
+ {
+ "description": "the write (io) of disk on the vm",
+ "name": "diskiowrite",
+ "type": "long"
+ },
+ {
+ "description": "State of the Service from LB rule",
+ "name": "servicestate",
+ "type": "string"
+ },
+ {
+ "description": "the target memory in vm",
+ "name": "memorytargetkbs",
+ "type": "long"
+ },
+ {
+ "description": "the ID of the host for the virtual machine",
+ "name": "hostid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the disk offering of the virtual machine",
+ "name": "diskofferingid",
+ "type": "string"
+ },
+ {
+ "description": "Guest vm Boot Mode",
+ "name": "bootmode",
+ "type": "string"
+ },
+ {
+ "description": "the name of the disk offering of the virtual machine",
+ "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 total number of network traffic bytes received",
- "name": "receivedbytes",
+ "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 vm to the end user or not.",
+ "name": "displayvm",
+ "type": "boolean"
+ },
+ {
+ "description": "user generated name. The name of the virtual machine is returned if no displayname exists.",
+ "name": "displayname",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the backup offering of the virtual machine",
+ "name": "backupofferingid",
+ "type": "string"
+ },
+ {
+ "description": "OS name of the vm",
+ "name": "osdisplayname",
+ "type": "string"
+ },
+ {
+ "description": "the incoming network traffic on the vm",
+ "name": "networkkbsread",
"type": "long"
},
{
+ "description": "the name of the template for the virtual machine",
+ "name": "templatename",
+ "type": "string"
+ },
+ {},
+ {
"description": "true if the password rest feature is enabled, false otherwise",
"name": "passwordenabled",
"type": "boolean"
},
{
- "description": "the name of the template for the virtual machine",
- "name": "templatename",
+ "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 ID who deployed the virtual machine",
+ "name": "userid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the ISO attached to the virtual machine",
+ "name": "isoid",
+ "type": "string"
+ },
+ {
+ "description": "instance name of the user vm; this parameter is returned to the ROOT admin only",
+ "name": "instancename",
+ "type": "string"
+ },
+ {
+ "description": "the project id of the vm",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the virtual network for the service offering",
+ "name": "forvirtualnetwork",
+ "type": "boolean"
+ },
+ {
+ "description": "the name of the host for the virtual machine",
+ "name": "hostname",
+ "type": "string"
+ },
+ {
+ "description": "the total number of network traffic bytes sent",
+ "name": "sentbytes",
+ "type": "long"
+ },
+ {},
+ {
+ "description": "the read (bytes) of disk on the vm",
+ "name": "diskkbsread",
+ "type": "long"
+ },
+ {
+ "description": "the ID of the domain in which the virtual machine exists",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the internal memory 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": "true if high-availability is enabled, false otherwise",
+ "name": "haenable",
+ "type": "boolean"
+ },
+ {
+ "description": "Guest vm Boot Type",
+ "name": "boottype",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the vm",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "device ID of the root volume",
+ "name": "rootdeviceid",
+ "type": "long"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the outgoing network traffic on the host",
+ "name": "networkkbswrite",
+ "type": "long"
+ },
+ {
+ "description": " an alternate display text of the template for the virtual machine",
+ "name": "templatedisplaytext",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the availablility zone for the virtual machine",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "OS type id of the vm",
+ "name": "ostypeid",
+ "type": "string"
+ },
+ {
+ "description": "the memory allocated for the virtual machine",
+ "name": "memory",
+ "type": "integer"
+ },
+ {
"description": "the ID of the 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",
+ "type": "string"
+ },
+ {
+ "description": "the name of the ISO attached to the virtual machine",
+ "name": "isoname",
+ "type": "string"
+ },
+ {
+ "description": "device type of the root volume",
+ "name": "rootdevicetype",
+ "type": "string"
+ },
+ {
+ "description": "the speed of each cpu",
+ "name": "cpuspeed",
+ "type": "integer"
+ },
+ {
"description": "list of security groups associated with the virtual machine",
"name": "securitygroup",
"response": [
{
- "description": "the domain ID of the security group",
- "name": "domainid",
+ "description": "the 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 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": "account owning the security group rule",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the ending IP of the security group rule ",
+ "name": "endport",
+ "type": "integer"
+ },
+ {
+ "description": "the CIDR notation for the base IP address of the security group rule",
+ "name": "cidr",
+ "type": "string"
+ },
+ {
+ "description": "the list of resource tags associated with the rule",
+ "name": "tags",
+ "response": [
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "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 key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the id of the security group rule",
+ "name": "ruleid",
+ "type": "string"
+ },
+ {
+ "description": "the starting IP of the security group rule",
+ "name": "startport",
+ "type": "integer"
+ },
+ {
+ "description": "the protocol of the security group rule",
+ "name": "protocol",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the list of virtualmachine ids associated with this securitygroup",
+ "name": "virtualmachineids",
+ "type": "set"
+ },
+ {
+ "description": "the domain name of the security group",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the description of the security group",
+ "name": "description",
"type": "string"
},
{
@@ -52203,8 +53066,8 @@
"type": "string"
},
{
- "description": "the account owning the security group",
- "name": "account",
+ "description": "the project name of the group",
+ "name": "project",
"type": "string"
},
{
@@ -52212,33 +53075,8 @@
"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": "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",
+ "description": "resource type",
+ "name": "resourcetype",
"type": "string"
},
{
@@ -52247,8 +53085,13 @@
"type": "string"
},
{
- "description": "customer associated with the tag",
- "name": "customer",
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
"type": "string"
},
{
@@ -52257,16 +53100,46 @@
"type": "string"
},
{
- "description": "resource type",
- "name": "resourcetype",
+ "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 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",
- "name": "project",
+ "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 domain ID of the security group",
+ "name": "domainid",
"type": "string"
},
{
@@ -52279,65 +53152,90 @@
"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",
+ "type": "string"
+ },
+ {
+ "description": "the type of the ICMP message response",
+ "name": "icmptype",
+ "type": "integer"
+ },
+ {
+ "description": "account owning the security group rule",
+ "name": "account",
+ "type": "string"
+ },
+ {
"description": "the list of resource tags associated with the rule",
"name": "tags",
"response": [
{
- "description": "the 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": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
"description": "the ID of the domain associated with the tag",
"name": "domainid",
"type": "string"
},
{
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
"description": "tag key name",
"name": "key",
"type": "string"
},
{
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
"description": "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 account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
}
],
"type": "set"
},
{
- "description": "the protocol of the security group rule",
- "name": "protocol",
+ "description": "security group name",
+ "name": "securitygroupname",
"type": "string"
},
{
@@ -52346,373 +53244,59 @@
"type": "string"
},
{
- "description": "the ending IP of the security group rule ",
- "name": "endport",
- "type": "integer"
- },
- {
- "description": "the type of the ICMP message response",
- "name": "icmptype",
- "type": "integer"
- },
- {
"description": "the code for the ICMP message response",
"name": "icmpcode",
"type": "integer"
- },
- {
- "description": "the 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"
}
],
"type": "set"
},
{
- "description": "the list of virtualmachine ids associated with this securitygroup",
- "name": "virtualmachineids",
- "type": "set"
- },
- {
- "description": "the description of the security group",
- "name": "description",
- "type": "string"
- },
- {
- "description": "the domain name of the security group",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the project id of the group",
- "name": "projectid",
- "type": "string"
- },
- {
"description": "the ID of the security group",
"name": "id",
"type": "string"
- },
- {
- "description": "the 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 protocol of the security group rule",
- "name": "protocol",
- "type": "string"
- },
- {
- "description": "the id of the security group rule",
- "name": "ruleid",
- "type": "string"
- },
- {
- "description": "the code for the ICMP message response",
- "name": "icmpcode",
- "type": "integer"
- },
- {
- "description": "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": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "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": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "the 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 starting IP of the security group rule",
- "name": "startport",
- "type": "integer"
- },
- {
- "description": "the ending IP of the security group rule ",
- "name": "endport",
- "type": "integer"
- },
- {
- "description": "the type of the ICMP message response",
- "name": "icmptype",
- "type": "integer"
- }
- ],
- "type": "set"
}
],
"type": "set"
- },
+ }
+ ]
+ },
+ {
+ "description": "Deletes a Kubernetes cluster",
+ "isasync": true,
+ "name": "deleteKubernetesSupportedVersion",
+ "params": [
{
- "description": "the memory used by the vm",
- "name": "memorykbs",
- "type": "long"
- },
- {
- "description": "Guest vm Boot Mode",
- "name": "bootmode",
- "type": "string"
- },
- {
- "description": "the write (bytes) of disk on the vm",
- "name": "diskkbswrite",
- "type": "long"
- },
+ "description": "the ID of the Kubernetes supported version",
+ "length": 255,
+ "name": "id",
+ "related": "addKubernetesSupportedVersion,listKubernetesSupportedVersions,updateKubernetesSupportedVersion",
+ "required": true,
+ "type": "uuid"
+ }
+ ],
+ "response": [
{},
{
- "description": "the group ID of the virtual machine",
- "name": "groupid",
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
- "description": "the ID of the host for the virtual machine",
- "name": "hostid",
- "type": "string"
- },
- {
- "description": "the password (if exists) of the virtual machine",
- "name": "password",
- "type": "string"
- },
- {
- "description": "an optional field whether to the display the vm to the end user or not.",
- "name": "displayvm",
+ "description": "true if operation is executed successfully",
+ "name": "success",
"type": "boolean"
},
- {
- "description": "the project name of the vm",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the ID of the ISO attached to the virtual machine",
- "name": "isoid",
- "type": "string"
- },
- {
- "description": "State of the Service from LB rule",
- "name": "servicestate",
- "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 netmask of the nic",
- "name": "netmask",
- "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": "true if nic is default, false otherwise",
- "name": "macaddress",
- "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": "the gateway of IPv6 network",
- "name": "ip6gateway",
- "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": "IP addresses associated with NIC found for unmanaged VM",
- "name": "ipaddresses",
- "type": "list"
- },
- {
- "description": "the type of the nic",
- "name": "type",
- "type": "string"
- },
- {
- "description": "device id for the network when plugged into the virtual machine",
- "name": "deviceid",
- "type": "string"
- },
- {
- "description": "the isolated private VLAN type if available",
- "name": "isolatedpvlantype",
- "type": "string"
- },
- {
- "description": "the name of the corresponding network",
- "name": "networkname",
- "type": "string"
- },
- {
- "description": "the traffic type of the nic",
- "name": "traffictype",
- "type": "string"
- },
- {
- "description": "Type of adapter if available",
- "name": "adaptertype",
- "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",
- "name": "id",
- "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": "true if nic is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
- },
- {
- "description": "the isolated private VLAN if available",
- "name": "isolatedpvlan",
- "type": "integer"
- },
- {
- "description": "the IPv6 address of network",
- "name": "ip6address",
- "type": "string"
- },
- {
- "description": "the ip address of the nic",
- "name": "ipaddress",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the write (io) of disk on the vm",
- "name": "diskiowrite",
- "type": "long"
+ "description": "any text associated with the success or failure",
+ "name": "displaytext",
+ "type": "string"
}
]
},
@@ -52722,13 +53306,34 @@
"name": "createTemplate",
"params": [
{
- "description": "true if this template is a public template, false otherwise",
+ "description": "true if the template requres HVM, false otherwise",
"length": 255,
- "name": "ispublic",
+ "name": "requireshvm",
"required": false,
"type": "boolean"
},
{
+ "description": "true if the template supports the sshkey upload feature; default is false",
+ "length": 255,
+ "name": "sshkeyenabled",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "the tag for this template.",
+ "length": 255,
+ "name": "templatetag",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the display text of the template. This is usually used for display purposes.",
+ "length": 4096,
+ "name": "displaytext",
+ "required": true,
+ "type": "string"
+ },
+ {
"description": "the name of the template",
"length": 255,
"name": "name",
@@ -52736,6 +53341,14 @@
"type": "string"
},
{
+ "description": "Optional, VM ID. If this presents, it is going to create a baremetal template for VM this ID refers to. This is only for VM whose hypervisor type is BareMetal",
+ "length": 255,
+ "name": "virtualmachineid",
+ "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance",
+ "required": false,
+ "type": "uuid"
+ },
+ {
"description": "true if the template supports the password reset feature; default is false",
"length": 255,
"name": "passwordenabled",
@@ -52743,6 +53356,13 @@
"type": "boolean"
},
{
+ "description": "true if this template is a public template, false otherwise",
+ "length": 255,
+ "name": "ispublic",
+ "required": false,
+ "type": "boolean"
+ },
+ {
"description": "the ID of the disk volume the template is being created from. Either this parameter, or snapshotId has to be passed in",
"length": 255,
"name": "volumeid",
@@ -52758,13 +53378,6 @@
"type": "map"
},
{
- "description": "true if this template is a featured template, false otherwise",
- "length": 255,
- "name": "isfeatured",
- "required": false,
- "type": "boolean"
- },
- {
"description": "32 or 64 bit",
"length": 255,
"name": "bits",
@@ -52772,64 +53385,6 @@
"type": "integer"
},
{
- "description": "true if the template requres HVM, false otherwise",
- "length": 255,
- "name": "requireshvm",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "Optional, VM ID. If this presents, it is going to create a baremetal template for VM this ID refers to. This is only for VM whose hypervisor type is BareMetal",
- "length": 255,
- "name": "virtualmachineid",
- "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance",
- "required": false,
- "type": "uuid"
- },
- {
- "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 tag for this template.",
- "length": 255,
- "name": "templatetag",
- "required": false,
- "type": "string"
- },
- {
- "description": "the ID of the OS Type that best represents the OS of this template.",
- "length": 255,
- "name": "ostypeid",
- "related": "listOsTypes,addGuestOs",
- "required": true,
- "type": "uuid"
- },
- {
- "description": "true if the template supports the sshkey upload feature; default is false",
- "length": 255,
- "name": "sshkeyenabled",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "the display text of the template. This is usually used for display purposes.",
- "length": 4096,
- "name": "displaytext",
- "required": true,
- "type": "string"
- },
- {
- "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory",
- "length": 255,
- "name": "isdynamicallyscalable",
- "required": false,
- "type": "boolean"
- },
- {
"description": "create template for the project",
"length": 255,
"name": "projectid",
@@ -52838,198 +53393,58 @@
"type": "uuid"
},
{
+ "description": "true if this template is a featured template, false otherwise",
+ "length": 255,
+ "name": "isfeatured",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "the ID of the OS Type that best represents the OS of this template.",
+ "length": 255,
+ "name": "ostypeid",
+ "related": "listOsTypes,addGuestOs",
+ "required": true,
+ "type": "uuid"
+ },
+ {
"description": "the ID of the snapshot the template is being created from. Either this parameter, or volumeId has to be passed in",
"length": 255,
"name": "snapshotid",
"related": "revertSnapshot",
"required": false,
"type": "uuid"
+ },
+ {
+ "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": "Optional, only for baremetal hypervisor. The directory name where template stored on CIFS server",
+ "length": 2048,
+ "name": "url",
+ "required": false,
+ "type": "string"
}
],
"related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos",
"response": [
{
- "description": "VMware only: additional key/value details tied with deploy-as-is template",
- "name": "deployasisdetails",
- "type": "map"
- },
- {
- "description": "the project name of the template",
- "name": "project",
+ "description": "the status of the template",
+ "name": "status",
"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": "the template display text",
- "name": "displaytext",
- "type": "string"
- },
- {
- "description": "checksum of the template",
- "name": "checksum",
- "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": "the size of the template",
- "name": "size",
- "type": "long"
- },
- {},
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "true if the reset password feature is enabled, false otherwise",
- "name": "passwordenabled",
- "type": "boolean"
- },
- {
- "description": "the name of the secondary storage host for the template",
- "name": "hostname",
- "type": "string"
- },
- {
- "description": "Lists the download progress of a template across all secondary storages",
- "name": "downloaddetails",
- "type": "list"
- },
- {
- "description": "the physical size of the template",
- "name": "physicalsize",
- "type": "long"
- },
- {
- "description": "true if this template is a public template, false otherwise",
- "name": "ispublic",
- "type": "boolean"
- },
- {
- "description": "the account name to which the template belongs",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the hypervisor on which the template runs",
- "name": "hypervisor",
- "type": "string"
- },
- {
- "description": "the template ID of the parent template if present",
- "name": "sourcetemplateid",
- "type": "string"
- },
- {
- "description": "true if the ISO is bootable, false otherwise",
- "name": "bootable",
- "type": "boolean"
- },
- {
- "description": "the date this template was removed",
- "name": "removed",
- "type": "date"
- },
- {
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
- },
- {
- "description": "the list of resource tags associated",
- "name": "tags",
- "response": [
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "the project 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": "the domain associated with the tag",
- "name": "domain",
- "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": "the URL which the template/iso is registered from",
- "name": "url",
- "type": "string"
- },
- {
- "description": "the processor bit size",
- "name": "bits",
- "type": "int"
- },
- {
- "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.",
- "name": "deployasis",
- "type": "boolean"
- },
- {
- "description": "true if this template is a featured template, false otherwise",
- "name": "isfeatured",
- "type": "boolean"
- },
- {
- "description": "true if the template is ready to be deployed from, false otherwise.",
- "name": "isready",
+ "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage",
+ "name": "directdownload",
"type": "boolean"
},
{
@@ -53038,43 +53453,23 @@
"type": "map"
},
{
- "description": "the ID of the domain to which the template belongs",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the status of the template",
- "name": "status",
- "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": "true if the template is extractable, false otherwise",
"name": "isextractable",
"type": "boolean"
},
{
- "description": "the template ID",
- "name": "id",
- "type": "string"
+ "description": "true if the reset password feature is enabled, false otherwise",
+ "name": "passwordenabled",
+ "type": "boolean"
},
{
- "description": "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 type of the template",
- "name": "templatetype",
+ "description": "the ID of the OS type for this template.",
+ "name": "ostypeid",
"type": "string"
},
{
@@ -53083,28 +53478,49 @@
"type": "string"
},
{
- "description": "if Datadisk template, then id of the root disk template this template belongs to",
- "name": "parenttemplateid",
+ "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.",
+ "name": "deployasis",
+ "type": "boolean"
+ },
+ {
+ "description": "the account name to which the template belongs",
+ "name": "account",
"type": "string"
},
{
- "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage",
- "name": "directdownload",
+ "description": "the size of the template",
+ "name": "size",
+ "type": "long"
+ },
+ {
+ "description": "the date this template was removed",
+ "name": "removed",
+ "type": "date"
+ },
+ {},
+ {
+ "description": "true if template is sshkey enabled, false otherwise",
+ "name": "sshkeyenabled",
"type": "boolean"
},
{
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
"description": "the account id to which the template belongs",
"name": "accountid",
"type": "string"
},
{
- "description": "the tag of this template",
- "name": "templatetag",
- "type": "string"
+ "description": "the physical size of the template",
+ "name": "physicalsize",
+ "type": "long"
},
{
- "description": "the name of the zone for this template",
- "name": "zonename",
+ "description": "the template ID of the parent template if present",
+ "name": "sourcetemplateid",
"type": "string"
},
{
@@ -53113,18 +53529,18 @@
"type": "integer"
},
{
- "description": "the format of the template.",
- "name": "format",
- "type": "imageformat"
- },
- {
- "description": "the name of the OS type for this template.",
- "name": "ostypename",
+ "description": "the URL which the template/iso is registered from",
+ "name": "url",
"type": "string"
},
{
- "description": "the ID of the OS type for this template.",
- "name": "ostypeid",
+ "description": "checksum of the template",
+ "name": "checksum",
+ "type": "string"
+ },
+ {
+ "description": "the template display text",
+ "name": "displaytext",
"type": "string"
},
{
@@ -53133,24 +53549,192 @@
"type": "boolean"
},
{
- "description": "true if the template is managed across all Zones, false otherwise",
- "name": "crossZones",
+ "description": "the name of the secondary storage host for the template",
+ "name": "hostname",
+ "type": "string"
+ },
+ {
+ "description": "the template ID",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the secondary storage host for the template",
+ "name": "hostid",
+ "type": "string"
+ },
+ {
+ "description": "if root disk template, then ids of the datas disk templates this template owns",
+ "name": "childtemplates",
+ "type": "set"
+ },
+ {
+ "description": "true if the template is ready to be deployed from, false otherwise.",
+ "name": "isready",
"type": "boolean"
},
{
+ "description": "the type of the template",
+ "name": "templatetype",
+ "type": "string"
+ },
+ {
+ "description": "the tag of this template",
+ "name": "templatetag",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the template",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the date this template was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
"description": "the project id of the template",
"name": "projectid",
"type": "string"
},
{
+ "description": "if Datadisk template, then id of the root disk template this template belongs to",
+ "name": "parenttemplateid",
+ "type": "string"
+ },
+ {
+ "description": "the list of resource tags associated",
+ "name": "tags",
+ "response": [
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the 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": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "true if this template is a public template, false otherwise",
+ "name": "ispublic",
+ "type": "boolean"
+ },
+ {
+ "description": "the hypervisor on which the template runs",
+ "name": "hypervisor",
+ "type": "string"
+ },
+ {
+ "description": "Lists the download progress of a template across all secondary storages",
+ "name": "downloaddetails",
+ "type": "list"
+ },
+ {
+ "description": "the name of the OS type for this template.",
+ "name": "ostypename",
+ "type": "string"
+ },
+ {
"description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory",
"name": "isdynamicallyscalable",
"type": "boolean"
},
{
+ "description": "true if the ISO is bootable, false otherwise",
+ "name": "bootable",
+ "type": "boolean"
+ },
+ {
+ "description": "the ID of the zone for this template",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the name of the zone for this template",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "VMware only: additional key/value details tied with deploy-as-is template",
+ "name": "deployasisdetails",
+ "type": "map"
+ },
+ {
+ "description": "the 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": "the format of the template.",
+ "name": "format",
+ "type": "imageformat"
+ },
+ {
+ "description": "true if template requires HVM enabled, false otherwise",
+ "name": "requireshvm",
+ "type": "boolean"
+ },
+ {
"description": "the name of the domain to which the template belongs",
"name": "domain",
"type": "string"
+ },
+ {
+ "description": "the ID of the domain to which the template belongs",
+ "name": "domainid",
+ "type": "string"
}
]
},
@@ -53160,6 +53744,13 @@
"name": "listBaremetalRct",
"params": [
{
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "",
"length": 255,
"name": "page",
@@ -53172,38 +53763,31 @@
"name": "pagesize",
"required": false,
"type": "integer"
- },
- {
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
}
],
"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": "id of rct",
- "name": "id",
- "type": "string"
- },
- {},
- {},
- {
"description": "url",
"name": "url",
"type": "string"
+ },
+ {
+ "description": "id of rct",
+ "name": "id",
+ "type": "string"
}
]
},
@@ -53213,20 +53797,6 @@
"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": "A name / alias for the certificate.",
"length": 255,
"name": "name",
@@ -53234,6 +53804,13 @@
"type": "string"
},
{
+ "description": "DNS domain suffix that the certificate is granted for.",
+ "length": 255,
+ "name": "domainsuffix",
+ "required": true,
+ "type": "string"
+ },
+ {
"description": "The private key for the attached certificate.",
"length": 65535,
"name": "privatekey",
@@ -53241,32 +53818,39 @@
"type": "string"
},
{
- "description": "DNS domain suffix that the certificate is granted for.",
- "length": 255,
- "name": "domainsuffix",
+ "description": "The certificate to be uploaded.",
+ "length": 65535,
+ "name": "certificate",
"required": true,
"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"
}
],
"related": "",
"response": [
{},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "message of the certificate upload operation",
+ "name": "message",
+ "type": "string"
},
- {},
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
{
- "description": "message of the certificate upload operation",
- "name": "message",
- "type": "string"
- }
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {}
]
},
{
@@ -53275,20 +53859,18 @@
"name": "listDedicatedClusters",
"params": [
{
- "description": "the ID of the domain associated with the cluster",
+ "description": "the name of the account associated with the cluster. Must be used with domainId.",
"length": 255,
- "name": "domainid",
- "related": "listDomainChildren,listDomains",
+ "name": "account",
"required": false,
- "type": "uuid"
+ "type": "string"
},
{
- "description": "the ID of the cluster",
+ "description": "",
"length": 255,
- "name": "clusterid",
- "related": "addCluster,updateCluster",
+ "name": "pagesize",
"required": false,
- "type": "uuid"
+ "type": "integer"
},
{
"description": "",
@@ -53298,17 +53880,10 @@
"type": "integer"
},
{
- "description": "the name of the account associated with the cluster. Must be used with domainId.",
+ "description": "the ID of the domain associated with the cluster",
"length": 255,
- "name": "account",
- "required": false,
- "type": "string"
- },
- {
- "description": "list dedicated clusters by affinity group",
- "length": 255,
- "name": "affinitygroupid",
- "related": "",
+ "name": "domainid",
+ "related": "listDomainChildren,listDomains",
"required": false,
"type": "uuid"
},
@@ -53320,37 +53895,51 @@
"type": "string"
},
{
- "description": "",
+ "description": "the ID of the cluster",
"length": 255,
- "name": "pagesize",
+ "name": "clusterid",
+ "related": "addCluster,updateCluster",
"required": false,
- "type": "integer"
+ "type": "uuid"
+ },
+ {
+ "description": "list dedicated clusters by affinity group",
+ "length": 255,
+ "name": "affinitygroupid",
+ "related": "",
+ "required": false,
+ "type": "uuid"
}
],
"related": "",
"response": [
+ {},
+ {
+ "description": "the domain ID of the cluster",
+ "name": "domainid",
+ "type": "string"
+ },
{
"description": "the ID of the cluster",
"name": "clusterid",
"type": "string"
},
{
+ "description": "the ID of the dedicated resource",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the name of the cluster",
+ "name": "clustername",
+ "type": "string"
+ },
+ {
"description": "the Dedication Affinity Group ID of the cluster",
"name": "affinitygroupid",
"type": "string"
},
{
- "description": "the 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"
@@ -53362,14 +53951,9 @@
"type": "string"
},
{
- "description": "the ID of the dedicated resource",
- "name": "id",
- "type": "string"
- },
- {
- "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"
}
]
},
@@ -53389,25 +53973,25 @@
"related": "",
"response": [
{
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {},
+ {
"description": "the description of the CA service provider",
"name": "description",
"type": "string"
},
{
- "description": "the CA service provider name",
- "name": "name",
- "type": "string"
- },
- {},
- {},
- {
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
+ {},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the CA service provider name",
+ "name": "name",
"type": "string"
}
],
@@ -53433,13 +54017,13 @@
"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",
@@ -53458,17 +54042,25 @@
"name": "listPortForwardingRules",
"params": [
{
- "description": "",
+ "description": "list objects by project",
"length": 255,
- "name": "page",
+ "name": "projectid",
+ "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject",
"required": false,
- "type": "integer"
+ "type": "uuid"
},
{
- "description": "Lists rule with the specified ID.",
+ "description": "list resources by account. Must be used with the domainId parameter.",
"length": 255,
- "name": "id",
- "related": "listPortForwardingRules,updatePortForwardingRule",
+ "name": "account",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the ID of IP address of the port forwarding services",
+ "length": 255,
+ "name": "ipaddressid",
+ "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses",
"required": false,
"type": "uuid"
},
@@ -53480,6 +54072,13 @@
"type": "string"
},
{
+ "description": "List resources by tags (key/value pairs)",
+ "length": 255,
+ "name": "tags",
+ "required": false,
+ "type": "map"
+ },
+ {
"description": "list port forwarding rules for certain network",
"length": 255,
"name": "networkid",
@@ -53489,20 +54088,13 @@
"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",
"length": 255,
- "name": "isrecursive",
+ "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 resources by display flag; only ROOT admin is eligible to pass this parameter",
"length": 255,
"name": "fordisplay",
@@ -53519,34 +54111,18 @@
"type": "uuid"
},
{
- "description": "the ID of IP address of the port forwarding services",
+ "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
"length": 255,
- "name": "ipaddressid",
- "related": "associateIpAddress,updateIpAddress,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",
- "length": 255,
- "name": "listall",
+ "name": "isrecursive",
"required": false,
"type": "boolean"
},
{
- "description": "List resources by tags (key/value pairs)",
+ "description": "",
"length": 255,
- "name": "tags",
+ "name": "page",
"required": false,
- "type": "map"
- },
- {
- "description": "list objects by project",
- "length": 255,
- "name": "projectid",
- "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject",
- "required": false,
- "type": "uuid"
+ "type": "integer"
},
{
"description": "",
@@ -53554,124 +54130,19 @@
"name": "pagesize",
"required": false,
"type": "integer"
+ },
+ {
+ "description": "Lists rule with the specified ID.",
+ "length": 255,
+ "name": "id",
+ "related": "listPortForwardingRules,updatePortForwardingRule",
+ "required": false,
+ "type": "uuid"
}
],
"related": "updatePortForwardingRule",
"response": [
{
- "description": "the public ip address for the port forwarding rule",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "description": "the vm ip address for the port forwarding rule",
- "name": "vmguestip",
- "type": "string"
- },
- {
- "description": "the 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": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- }
- ],
- "type": "list"
- },
- {
- "description": "the ID of the port forwarding rule",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the starting port of port forwarding rule's private port range",
- "name": "privateport",
- "type": "string"
- },
- {
- "description": "the 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 ending port of port forwarding rule's private port range",
- "name": "privateendport",
- "type": "string"
- },
- {
- "description": "the ending port of port forwarding rule's private port range",
- "name": "publicendport",
- "type": "string"
- },
- {
- "description": "the protocol of the port forwarding rule",
- "name": "protocol",
- "type": "string"
- },
- {
- "description": "the VM ID for the port forwarding rule",
- "name": "virtualmachineid",
- "type": "string"
- },
- {
- "description": "is firewall for display to the regular user",
- "name": "fordisplay",
- "type": "boolean"
- },
- {
"description": "the id of the guest network the port forwarding rule belongs to",
"name": "networkid",
"type": "string"
@@ -53683,13 +54154,8 @@
"type": "string"
},
{
- "description": "the VM display name for the port forwarding rule",
- "name": "virtualmachinedisplayname",
- "type": "string"
- },
- {
- "description": "the VM name for the port forwarding rule",
- "name": "virtualmachinename",
+ "description": "the starting port of port forwarding rule's private port range",
+ "name": "privateport",
"type": "string"
},
{
@@ -53698,14 +54164,132 @@
"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 ID of the port forwarding rule",
+ "name": "id",
+ "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 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 state of the rule",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "is firewall for display to the regular user",
+ "name": "fordisplay",
+ "type": "boolean"
+ },
+ {
+ "description": "the list of resource tags associated with the rule",
+ "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": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ }
+ ],
+ "type": "list"
+ },
+ {
"description": "the public ip address id for the port forwarding rule",
"name": "ipaddressid",
"type": "string"
+ },
+ {
+ "description": "the ending port of port forwarding rule's private port range",
+ "name": "privateendport",
+ "type": "string"
+ },
+ {
+ "description": "the protocol of the port forwarding rule",
+ "name": "protocol",
+ "type": "string"
}
]
},
@@ -53734,11 +54318,6 @@
"related": "",
"response": [
{
- "description": "the ID of the pod the IP address belongs to",
- "name": "podid",
- "type": "long"
- },
- {
"description": "MAC address of the pod the IP",
"name": "hostmac",
"type": "long"
@@ -53748,27 +54327,21 @@
"name": "id",
"type": "long"
},
- {},
- {
- "description": "Gateway for Pod ",
- "name": "gateway",
- "type": "string"
- },
- {},
- {
- "description": "Allocated IP address",
- "name": "ipaddress",
- "type": "string"
- },
{
"description": "CIDR of the Pod",
"name": "cidr",
"type": "string"
},
+ {},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "the ID of the pod the IP address belongs to",
+ "name": "podid",
+ "type": "long"
+ },
+ {
+ "description": "Allocated IP address",
+ "name": "ipaddress",
+ "type": "string"
},
{
"description": "the UUID of the latest async job acting on this object",
@@ -53776,9 +54349,20 @@
"type": "string"
},
{
+ "description": "Gateway for Pod ",
+ "name": "gateway",
+ "type": "string"
+ },
+ {},
+ {
"description": "the ID of the nic",
"name": "nicid",
"type": "long"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
}
]
},
@@ -53799,39 +54383,28 @@
"related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,disableOutOfBandManagementForCluster",
"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 out-of-band management interface password",
- "name": "password",
- "type": "string"
- },
- {
"description": "the ID of the host",
"name": "hostid",
"type": "string"
},
{
- "description": "true if out-of-band management is enabled for the host",
- "name": "enabled",
+ "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": "the operation result",
+ "name": "status",
"type": "boolean"
},
{
- "description": "the out-of-band management action (if issued)",
- "name": "action",
- "type": "string"
- },
- {},
- {
- "description": "the operation result description",
- "name": "description",
+ "description": "the out-of-band management interface address",
+ "name": "address",
"type": "string"
},
{
@@ -53840,27 +54413,38 @@
"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 operation result",
- "name": "status",
- "type": "boolean"
- },
- {
- "description": "the out-of-band management interface username",
- "name": "username",
+ "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 action (if issued)",
+ "name": "action",
"type": "string"
},
{
+ "description": "the out-of-band management interface password",
+ "name": "password",
+ "type": "string"
+ },
+ {},
+ {
"description": "the out-of-band management interface port",
"name": "port",
"type": "string"
@@ -53874,14 +54458,6 @@
"name": "updateTemplatePermissions",
"params": [
{
- "description": "the template ID",
- "length": 255,
- "name": "id",
- "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos",
- "required": true,
- "type": "uuid"
- },
- {
"description": "true for featured template/iso, false otherwise",
"length": 255,
"name": "isfeatured",
@@ -53889,13 +54465,6 @@
"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,
"name": "op",
@@ -53903,11 +54472,11 @@
"type": "string"
},
{
- "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": "a comma delimited list of projects. If specified, \"op\" parameter has to be passed in.",
@@ -53918,6 +54487,21 @@
"type": "list"
},
{
+ "description": "a comma delimited list of accounts within caller's domain. If specified, \"op\" parameter has to be passed in.",
+ "length": 255,
+ "name": "accounts",
+ "required": false,
+ "type": "list"
+ },
+ {
+ "description": "the template ID",
+ "length": 255,
+ "name": "id",
+ "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos",
+ "required": true,
+ "type": "uuid"
+ },
+ {
"description": "true if the template/iso is extractable, false other wise. Can be set only by root admin",
"length": 255,
"name": "isextractable",
@@ -53926,6 +54510,8 @@
}
],
"response": [
+ {},
+ {},
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
@@ -53936,18 +54522,16 @@
"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"
+ }
]
},
{
@@ -53956,6 +54540,13 @@
"name": "listTrafficMonitors",
"params": [
{
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "",
"length": 255,
"name": "page",
@@ -53963,33 +54554,36 @@
"type": "integer"
},
{
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
"description": "zone Id",
"length": 255,
"name": "zoneid",
"related": "createZone,updateZone,listZones,listZones",
"required": true,
"type": "uuid"
- },
- {
- "description": "",
- "length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
- },
- {
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
}
],
"related": "addTrafficMonitor",
"response": [
{
- "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 UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the management IP address of the external firewall",
+ "name": "ipaddress",
"type": "string"
},
{
@@ -53998,15 +54592,9 @@
"type": "string"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "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",
@@ -54014,14 +54602,10 @@
"type": "string"
},
{},
+ {},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "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"
}
]
@@ -54043,53 +54627,633 @@
"related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance",
"response": [
{
- "description": "the pool type of the virtual machine",
- "name": "pooltype",
- "type": "string"
- },
- {
"description": "the account associated with the virtual machine",
"name": "account",
"type": "string"
},
{
- "description": "State of the Service from LB rule",
- "name": "servicestate",
- "type": "string"
- },
- {
- "description": "the name of the virtual machine",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the write (io) of disk on the vm",
- "name": "diskiowrite",
- "type": "long"
- },
- {
- "description": "the number of cpu this virtual machine is running with",
- "name": "cpunumber",
+ "description": "the speed of each cpu",
+ "name": "cpuspeed",
"type": "integer"
},
{
- "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 ISO attached to the virtual machine",
+ "name": "isodisplaytext",
"type": "string"
},
{
- "description": "an optional field whether to the display the vm to the end user or not.",
- "name": "displayvm",
+ "description": "the name of the backup offering of the virtual machine",
+ "name": "backupofferingname",
+ "type": "string"
+ },
+ {
+ "description": "the date when this virtual machine was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
"type": "boolean"
},
{
- "description": "the memory used by the vm",
- "name": "memorykbs",
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the project id of the vm",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "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",
+ "description": "the read (io) of disk on the vm",
+ "name": "diskioread",
+ "type": "long"
+ },
+ {
+ "description": "the virtual network for the service offering",
+ "name": "forvirtualnetwork",
+ "type": "boolean"
+ },
+ {
+ "description": "the list of nics associated with vm",
+ "name": "nic",
+ "response": [
+ {
+ "description": "the IPv6 address of network",
+ "name": "ip6address",
+ "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": "ID of the VLAN/VNI if available",
+ "name": "vlanid",
+ "type": "integer"
+ },
+ {
+ "description": "the ID of the nic",
+ "name": "id",
+ "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 ip address of the nic",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "true if nic is default, false otherwise",
+ "name": "macaddress",
+ "type": "string"
+ },
+ {
+ "description": "true if nic is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {
+ "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise",
+ "name": "nsxlogicalswitchport",
+ "type": "string"
+ },
+ {
+ "description": "the isolated private VLAN type if available",
+ "name": "isolatedpvlantype",
+ "type": "string"
+ },
+ {
+ "description": "the isolated private VLAN if available",
+ "name": "isolatedpvlan",
+ "type": "integer"
+ },
+ {
+ "description": "Type of adapter if available",
+ "name": "adaptertype",
+ "type": "string"
+ },
+ {
+ "description": "device id for the network when plugged into the virtual machine",
+ "name": "deviceid",
+ "type": "string"
+ },
+ {
+ "description": "the isolation uri of the nic",
+ "name": "isolationuri",
+ "type": "string"
+ },
+ {
+ "description": "IP addresses associated with NIC found for unmanaged VM",
+ "name": "ipaddresses",
+ "type": "list"
+ },
+ {
+ "description": "the extra dhcp options on the nic",
+ "name": "extradhcpoption",
+ "type": "list"
+ },
+ {
+ "description": "the type of the nic",
+ "name": "type",
+ "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 vm to which the nic belongs",
+ "name": "virtualmachineid",
+ "type": "string"
+ },
+ {
+ "description": "the broadcast uri of the nic",
+ "name": "broadcasturi",
+ "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 corresponding network",
+ "name": "networkid",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the password (if exists) of the virtual machine",
+ "name": "password",
+ "type": "string"
+ },
+ {
+ "description": "the outgoing network traffic on the host",
+ "name": "networkkbswrite",
+ "type": "long"
+ },
+ {},
+ {
+ "description": "the ID of the availablility zone for the virtual machine",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the group name of the virtual machine",
+ "name": "group",
+ "type": "string"
+ },
+ {
+ "description": "the read (bytes) of disk on the vm",
+ "name": "diskkbsread",
+ "type": "long"
+ },
+ {
+ "description": "the amount of the vm's CPU currently used",
+ "name": "cpuused",
+ "type": "string"
+ },
+ {
+ "description": "true if the password rest feature is enabled, false otherwise",
+ "name": "passwordenabled",
+ "type": "boolean"
+ },
+ {
+ "description": "the total number of network traffic bytes received",
+ "name": "receivedbytes",
+ "type": "long"
+ },
+ {
+ "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": "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": "OS name of the vm",
+ "name": "osdisplayname",
+ "type": "string"
+ },
+ {
+ "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": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "description": "Vm details in key/value pairs.",
+ "name": "details",
+ "type": "map"
+ },
+ {
+ "description": "list of security groups associated with the virtual machine",
+ "name": "securitygroup",
+ "response": [
+ {
+ "description": "the domain ID of the security group",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the security group",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the account owning the security group",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the list of 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": "security group name",
+ "name": "securitygroupname",
+ "type": "string"
+ },
+ {
+ "description": "the type of the ICMP message response",
+ "name": "icmptype",
+ "type": "integer"
+ },
+ {
+ "description": "the id of the security group rule",
+ "name": "ruleid",
+ "type": "string"
+ },
+ {
+ "description": "the starting IP of the security group rule",
+ "name": "startport",
+ "type": "integer"
+ },
+ {
+ "description": "the ending IP of the security group rule ",
+ "name": "endport",
+ "type": "integer"
+ },
+ {
+ "description": "the list of resource tags associated with the rule",
+ "name": "tags",
+ "response": [
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the 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 name of the security group",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the domain name of the security group",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the list of virtualmachine ids associated with this securitygroup",
+ "name": "virtualmachineids",
+ "type": "set"
+ },
+ {
+ "description": "the list of egress rules associated with the security group",
+ "name": "egressrule",
+ "response": [
+ {
+ "description": "the id of the security group rule",
+ "name": "ruleid",
+ "type": "string"
+ },
+ {
+ "description": "the protocol of the security group rule",
+ "name": "protocol",
+ "type": "string"
+ },
+ {
+ "description": "the starting IP of the security group rule",
+ "name": "startport",
+ "type": "integer"
+ },
+ {
+ "description": "the type of the ICMP message response",
+ "name": "icmptype",
+ "type": "integer"
+ },
+ {
+ "description": "account owning the security group rule",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the list of resource tags associated with the rule",
+ "name": "tags",
+ "response": [
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the ending IP of the security group rule ",
+ "name": "endport",
+ "type": "integer"
+ },
+ {
+ "description": "security group name",
+ "name": "securitygroupname",
+ "type": "string"
+ },
+ {
+ "description": "the CIDR notation for the base IP address of the security group rule",
+ "name": "cidr",
+ "type": "string"
+ },
+ {
+ "description": "the code for the ICMP message response",
+ "name": "icmpcode",
+ "type": "integer"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the 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 ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the 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"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.",
+ "name": "isdynamicallyscalable",
+ "type": "boolean"
+ },
+ {
+ "description": "the project name of the vm",
+ "name": "project",
+ "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"
},
{
@@ -54098,63 +55262,28 @@
"type": "string"
},
{
- "description": "the write (bytes) of disk on the vm",
- "name": "diskkbswrite",
- "type": "long"
- },
- {
- "description": "the project name of the vm",
- "name": "project",
+ "description": "ssh key-pair",
+ "name": "keypair",
"type": "string"
},
{
- "description": "OS type id of the vm",
- "name": "ostypeid",
+ "description": "the user's name who deployed the virtual machine",
+ "name": "username",
"type": "string"
},
{
- "description": "device type of the root volume",
- "name": "rootdevicetype",
+ "description": "the name of the host for the virtual machine",
+ "name": "hostname",
"type": "string"
},
{
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
+ "description": "an optional field whether to the display the vm to the end user or not.",
+ "name": "displayvm",
"type": "boolean"
},
{
- "description": "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": "true if high-availability is enabled, false otherwise",
- "name": "haenable",
- "type": "boolean"
- },
- {
- "description": "the name of the backup offering of the virtual machine",
- "name": "backupofferingname",
- "type": "string"
- },
- {
- "description": "the password (if exists) of the virtual machine",
- "name": "password",
- "type": "string"
- },
- {
- "description": "Os type ID of the virtual machine",
- "name": "guestosid",
- "type": "string"
- },
- {
- "description": "the ID of the domain in which the virtual machine exists",
- "name": "domainid",
+ "description": "List of read-only Vm details as comma separated string.",
+ "name": "readonlydetails",
"type": "string"
},
{
@@ -54162,8 +55291,13 @@
"name": "affinitygroup",
"response": [
{
- "description": "the type of the affinity group",
- "name": "type",
+ "description": "the name of the affinity group",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the account owning the affinity group",
+ "name": "account",
"type": "string"
},
{
@@ -54172,13 +55306,28 @@
"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 account owning the affinity group",
- "name": "account",
+ "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 description of the affinity group",
+ "name": "description",
"type": "string"
},
{
@@ -54190,70 +55339,54 @@
"description": "the project name of the affinity group",
"name": "project",
"type": "string"
- },
- {
- "description": "the ID of the affinity group",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the name of the affinity group",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the description of the affinity group",
- "name": "description",
- "type": "string"
- },
- {
- "description": "virtual machine IDs associated with this affinity group",
- "name": "virtualmachineIds",
- "type": "list"
}
],
"type": "set"
},
- {},
{
- "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": "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": "public IP address id associated with vm via Static nat rule",
"name": "publicip",
"type": "string"
},
{},
{
- "description": "true if the password rest feature is enabled, false otherwise",
- "name": "passwordenabled",
- "type": "boolean"
- },
- {
- "description": "the read (bytes) of disk on the vm",
- "name": "diskkbsread",
- "type": "long"
- },
- {
- "description": "public IP address id associated with vm via Static nat rule",
- "name": "publicipid",
+ "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",
+ "description": "the pool type of the virtual machine",
+ "name": "pooltype",
+ "type": "string"
+ },
+ {
+ "description": "the name of the disk offering of the virtual machine",
+ "name": "diskofferingname",
+ "type": "string"
+ },
+ {
+ "description": "device type of the root volume",
+ "name": "rootdevicetype",
+ "type": "string"
+ },
+ {
+ "description": "the internal memory that's free in vm or zero if it can not be calculated",
+ "name": "memoryintfreekbs",
+ "type": "long"
+ },
+ {
+ "description": "instance name of the user vm; this parameter is returned to the ROOT admin only",
+ "name": "instancename",
+ "type": "string"
+ },
+ {
+ "description": "the name of the virtual machine",
+ "name": "name",
"type": "string"
},
{
@@ -54262,736 +55395,187 @@
"type": "string"
},
{
- "description": "the date when this virtual machine was updated last time",
- "name": "lastupdated",
- "type": "date"
- },
- {},
- {
- "description": "the target memory in vm",
- "name": "memorytargetkbs",
- "type": "long"
- },
- {
- "description": "list of security groups associated with the virtual machine",
- "name": "securitygroup",
- "response": [
- {
- "description": "the domain name of the security group",
- "name": "domain",
- "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 account owning the security group",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the list of resource tags associated with the rule",
- "name": "tags",
- "response": [
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "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": "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": "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"
- }
- ],
- "type": "set"
- },
- {
- "description": "the domain ID of the security group",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the description of the security group",
- "name": "description",
- "type": "string"
- },
- {
- "description": "the number of virtualmachines associated with this securitygroup",
- "name": "virtualmachinecount",
- "type": "integer"
- },
- {
- "description": "the project name of the group",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the list of virtualmachine ids associated with this securitygroup",
- "name": "virtualmachineids",
- "type": "set"
- },
- {
- "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 starting IP of the security group rule",
- "name": "startport",
- "type": "integer"
- },
- {
- "description": "the list of resource tags associated with the rule",
- "name": "tags",
- "response": [
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "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": "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": "security group name",
- "name": "securitygroupname",
- "type": "string"
- },
- {
- "description": "the ending IP of the security group rule ",
- "name": "endport",
- "type": "integer"
- },
- {
- "description": "the id of the security group rule",
- "name": "ruleid",
- "type": "string"
- },
- {
- "description": "the CIDR notation for the base IP address of the security group rule",
- "name": "cidr",
- "type": "string"
- },
- {
- "description": "account owning the security group rule",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the code for the ICMP message response",
- "name": "icmpcode",
- "type": "integer"
- }
- ],
- "type": "set"
- },
- {
- "description": "the project id of the group",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the list of egress rules associated with the security group",
- "name": "egressrule",
- "response": [
- {
- "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": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "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": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the id of the security group rule",
- "name": "ruleid",
- "type": "string"
- },
- {
- "description": "the protocol of the security group rule",
- "name": "protocol",
- "type": "string"
- },
- {
- "description": "the code for the ICMP message response",
- "name": "icmpcode",
- "type": "integer"
- },
- {
- "description": "security group name",
- "name": "securitygroupname",
- "type": "string"
- },
- {
- "description": "account owning the security group rule",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the CIDR notation for the base IP address of the security group rule",
- "name": "cidr",
- "type": "string"
- },
- {
- "description": "the 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"
- }
- ],
- "type": "set"
- },
- {
- "description": "ssh key-pair",
- "name": "keypair",
- "type": "string"
- },
- {
- "description": "the ID of the service offering of the virtual machine",
- "name": "serviceofferingid",
- "type": "string"
- },
- {
- "description": "the ID of the disk offering of the virtual machine",
- "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": "IP addresses associated with NIC found for unmanaged VM",
- "name": "ipaddresses",
- "type": "list"
- },
- {
- "description": "true if nic is default, false otherwise",
- "name": "macaddress",
- "type": "string"
- },
- {
- "description": "the isolated private VLAN type if available",
- "name": "isolatedpvlantype",
- "type": "string"
- },
- {
- "description": "the traffic type of the nic",
- "name": "traffictype",
- "type": "string"
- },
- {
- "description": "device id for the network when plugged into the virtual machine",
- "name": "deviceid",
- "type": "string"
- },
- {
- "description": "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": "the type of the nic",
- "name": "type",
- "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 ID of the nic",
- "name": "id",
- "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": "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 ID of the corresponding network",
- "name": "networkid",
- "type": "string"
- },
- {
- "description": "the gateway of the nic",
- "name": "gateway",
- "type": "string"
- },
- {
- "description": "the name of the corresponding network",
- "name": "networkname",
- "type": "string"
- },
- {
- "description": "the isolated private VLAN if available",
- "name": "isolatedpvlan",
- "type": "integer"
- },
- {
- "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise",
- "name": "nsxlogicalswitchport",
- "type": "string"
- },
- {
- "description": "the gateway of IPv6 network",
- "name": "ip6gateway",
- "type": "string"
- },
- {
- "description": "ID of the VLAN/VNI if available",
- "name": "vlanid",
- "type": "integer"
- },
- {
- "description": "Type of adapter if available",
- "name": "adaptertype",
- "type": "string"
- },
- {
- "description": "the ip address of the nic",
- "name": "ipaddress",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the hypervisor on which the template runs",
- "name": "hypervisor",
- "type": "string"
- },
- {
- "description": "the project id of the vm",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the 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",
- "type": "string"
- },
- {
- "description": "the memory allocated for the virtual machine",
- "name": "memory",
- "type": "integer"
- },
- {
- "description": "the name of the disk offering of the virtual machine",
- "name": "diskofferingname",
- "type": "string"
- },
- {
- "description": "Guest vm Boot Type",
- "name": "boottype",
- "type": "string"
- },
- {
- "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": "the vgpu type used by the virtual machine",
- "name": "vgpu",
- "type": "string"
- },
- {
- "description": "the speed of each cpu",
- "name": "cpuspeed",
- "type": "integer"
- },
- {
- "description": "the outgoing network traffic on the host",
- "name": "networkkbswrite",
+ "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": "List of read-only Vm details as comma separated string.",
- "name": "readonlydetails",
- "type": "string"
- },
- {
- "description": "the ID of the host for the virtual machine",
- "name": "hostid",
- "type": "string"
- },
- {
"description": " an alternate display text of the template for the virtual machine",
"name": "templatedisplaytext",
"type": "string"
},
{
- "description": "the name of the host for the virtual machine",
- "name": "hostname",
- "type": "string"
- },
- {
- "description": "the list of resource tags associated",
- "name": "tags",
- "response": [
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "the 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 ID of the virtual machine",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the ID of the availablility zone for the virtual machine",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the date when this virtual machine was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the group name of the virtual machine",
- "name": "group",
- "type": "string"
- },
- {
- "description": "the 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 virtual network for the service offering",
- "name": "forvirtualnetwork",
- "type": "boolean"
- },
- {
- "description": "the name of the domain in which the virtual machine exists",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.",
- "name": "isdynamicallyscalable",
- "type": "boolean"
- },
- {
- "description": "the internal memory that's free in vm or zero if it can not be calculated",
- "name": "memoryintfreekbs",
- "type": "long"
- },
- {
- "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",
"type": "string"
},
{
- "description": "OS name of the vm",
- "name": "osdisplayname",
+ "description": "Os type ID of the virtual machine",
+ "name": "guestosid",
"type": "string"
},
{
+ "description": "OS type id of the vm",
+ "name": "ostypeid",
+ "type": "string"
+ },
+ {
+ "description": "the number of cpu this virtual machine is running with",
+ "name": "cpunumber",
+ "type": "integer"
+ },
+ {
+ "description": "user generated name. The name of the virtual machine is returned if no displayname exists.",
+ "name": "displayname",
+ "type": "string"
+ },
+ {
+ "description": "the name of the service offering of the virtual machine",
+ "name": "serviceofferingname",
+ "type": "string"
+ },
+ {
+ "description": "the write (bytes) of disk on the vm",
+ "name": "diskkbswrite",
+ "type": "long"
+ },
+ {},
+ {
+ "description": "the name of the template for the virtual machine",
+ "name": "templatename",
+ "type": "string"
+ },
+ {
+ "description": "Guest vm Boot Type",
+ "name": "boottype",
+ "type": "string"
+ },
+ {
+ "description": "the list of resource tags associated",
+ "name": "tags",
+ "response": [
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "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",
+ "type": "string"
+ },
+ {
+ "description": "the state of the virtual machine",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "the target memory in vm",
+ "name": "memorytargetkbs",
+ "type": "long"
+ },
+ {
+ "description": "the ID of the disk offering of the virtual machine",
+ "name": "diskofferingid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the service offering of the virtual machine",
+ "name": "serviceofferingid",
+ "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 incoming network traffic on the vm",
"name": "networkkbsread",
"type": "long"
},
{
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
+ "description": "the memory allocated for the virtual machine",
+ "name": "memory",
+ "type": "integer"
+ },
+ {
+ "description": "the memory used by the vm",
+ "name": "memorykbs",
+ "type": "long"
+ },
+ {
+ "description": "State of the Service from LB rule",
+ "name": "servicestate",
+ "type": "string"
},
{
"description": "the total number of network traffic bytes sent",
"name": "sentbytes",
"type": "long"
- },
- {
- "description": "the name of the template for the virtual machine",
- "name": "templatename",
- "type": "string"
- },
- {
- "description": "device ID of the root volume",
- "name": "rootdeviceid",
- "type": "long"
}
]
},
@@ -55001,21 +55585,6 @@
"name": "updatePortForwardingRule",
"params": [
{
- "description": "the ID of the virtual machine for the port forwarding rule",
- "length": 255,
- "name": "virtualmachineid",
- "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "the private start port of the port forwarding rule",
- "length": 255,
- "name": "privateport",
- "required": false,
- "type": "integer"
- },
- {
"description": "an optional field, whether to the display the rule to the end user or not",
"length": 255,
"name": "fordisplay",
@@ -55024,12 +55593,11 @@
"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 private start port of the port forwarding rule",
"length": 255,
- "name": "customid",
+ "name": "privateport",
"required": false,
- "since": "4.4",
- "type": "string"
+ "type": "integer"
},
{
"description": "the ID of the port forwarding rule",
@@ -55041,11 +55609,19 @@
"type": "uuid"
},
{
- "description": "VM guest nic Secondary ip address for the port forwarding rule",
+ "description": "the ID of the virtual machine for the port forwarding rule",
"length": 255,
- "name": "vmguestip",
+ "name": "virtualmachineid",
+ "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance",
"required": false,
- "since": "4.5",
+ "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"
},
{
@@ -55054,19 +55630,21 @@
"name": "privateendport",
"required": false,
"type": "integer"
+ },
+ {
+ "description": "VM guest nic Secondary ip address for the port forwarding rule",
+ "length": 255,
+ "name": "vmguestip",
+ "required": false,
+ "since": "4.5",
+ "type": "string"
}
],
"related": "",
"response": [
{
- "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 protocol of the port forwarding rule",
+ "name": "protocol",
"type": "string"
},
{
@@ -55075,8 +55653,45 @@
"type": "string"
},
{
- "description": "the ending port of port forwarding rule's private port range",
- "name": "publicendport",
+ "description": "is firewall for display to the regular user",
+ "name": "fordisplay",
+ "type": "boolean"
+ },
+ {},
+ {},
+ {
+ "description": "the vm ip address for the port forwarding rule",
+ "name": "vmguestip",
+ "type": "string"
+ },
+ {
+ "description": "the 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 id of the guest network the port forwarding rule belongs to",
+ "name": "networkid",
+ "type": "string"
+ },
+ {
+ "description": "the VM ID for the port forwarding rule",
+ "name": "virtualmachineid",
+ "type": "string"
+ },
+ {
+ "description": "the starting port of port forwarding rule's private port range",
+ "name": "privateport",
+ "type": "string"
+ },
+ {
+ "description": "the VM name for the port forwarding rule",
+ "name": "virtualmachinename",
"type": "string"
},
{
@@ -55085,22 +55700,27 @@
"type": "string"
},
{
- "description": "is firewall for display to the regular user",
- "name": "fordisplay",
- "type": "boolean"
- },
- {
"description": "the list of resource tags associated with the rule",
"name": "tags",
"response": [
{
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
"description": "tag value",
"name": "value",
"type": "string"
},
{
- "description": "resource type",
- "name": "resourcetype",
+ "description": "the account associated with the tag",
+ "name": "account",
"type": "string"
},
{
@@ -55114,8 +55734,13 @@
"type": "string"
},
{
- "description": "customer associated with the tag",
- "name": "customer",
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
"type": "string"
},
{
@@ -55124,23 +55749,8 @@
"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 ID of the domain associated with the tag",
- "name": "domainid",
+ "description": "customer associated with the tag",
+ "name": "customer",
"type": "string"
}
],
@@ -55148,7 +55758,12 @@
},
{
"description": "the ending port of port forwarding rule's private port range",
- "name": "privateendport",
+ "name": "publicendport",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the port forwarding rule",
+ "name": "id",
"type": "string"
},
{
@@ -55157,23 +55772,8 @@
"type": "string"
},
{
- "description": "the VM display name for the port forwarding rule",
- "name": "virtualmachinedisplayname",
- "type": "string"
- },
- {
- "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).",
- "name": "cidrlist",
- "type": "string"
- },
- {
- "description": "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",
+ "description": "the starting port of port forwarding rule's public port range",
+ "name": "publicport",
"type": "string"
},
{
@@ -55182,29 +55782,13 @@
"type": "string"
},
{
- "description": "the VM ID for the port forwarding rule",
- "name": "virtualmachineid",
+ "description": "the ending port of port forwarding rule's private port range",
+ "name": "privateendport",
"type": "string"
},
{
- "description": "the protocol of the port forwarding rule",
- "name": "protocol",
- "type": "string"
- },
- {
- "description": "the starting port of port forwarding rule's public port range",
- "name": "publicport",
- "type": "string"
- },
- {
- "description": "the starting port of port forwarding rule's private port range",
- "name": "privateport",
- "type": "string"
- },
- {},
- {
- "description": "the VM name for the port forwarding rule",
- "name": "virtualmachinename",
+ "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).",
+ "name": "cidrlist",
"type": "string"
}
]
@@ -55215,13 +55799,6 @@
"name": "listBrocadeVcsDevices",
"params": [
{
- "description": "",
- "length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
- },
- {
"description": "List by keyword",
"length": 255,
"name": "keyword",
@@ -55229,11 +55806,12 @@
"type": "string"
},
{
- "description": "",
+ "description": "Brocade VCS switch ID",
"length": 255,
- "name": "pagesize",
+ "name": "vcsdeviceid",
+ "related": "listBrocadeVcsDevices",
"required": false,
- "type": "integer"
+ "type": "uuid"
},
{
"description": "the Physical Network ID",
@@ -55244,12 +55822,18 @@
"type": "uuid"
},
{
- "description": "Brocade VCS switch ID",
+ "description": "",
"length": 255,
- "name": "vcsdeviceid",
- "related": "listBrocadeVcsDevices",
+ "name": "pagesize",
"required": false,
- "type": "uuid"
+ "type": "integer"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
}
],
"related": "",
@@ -55260,6 +55844,22 @@
"type": "string"
},
{
+ "description": "name of the provider",
+ "name": "provider",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {},
+ {
+ "description": "the physical Network to which this Brocade VCS belongs to",
+ "name": "physicalnetworkid",
+ "type": "string"
+ },
+ {
"description": "device name",
"name": "brocadedevicename",
"type": "string"
@@ -55274,23 +55874,7 @@
"description": "device id of the Brocade Vcs",
"name": "vcsdeviceid",
"type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the physical Network to which this Brocade VCS belongs to",
- "name": "physicalnetworkid",
- "type": "string"
- },
- {
- "description": "name of the provider",
- "name": "provider",
- "type": "string"
- },
- {}
+ }
]
},
{
@@ -55299,16 +55883,9 @@
"name": "linkDomainToLdap",
"params": [
{
- "description": "Type of the account to auto import. Specify 0 for user and 2 for domain admin",
+ "description": "name of the group or OU in LDAP",
"length": 255,
- "name": "accounttype",
- "required": true,
- "type": "short"
- },
- {
- "description": "domain admin username in LDAP ",
- "length": 255,
- "name": "admin",
+ "name": "name",
"required": false,
"type": "string"
},
@@ -55321,6 +55898,13 @@
"type": "uuid"
},
{
+ "description": "domain admin username in LDAP ",
+ "length": 255,
+ "name": "admin",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "name of the group or OU in LDAP",
"length": 255,
"name": "ldapdomain",
@@ -55328,11 +55912,11 @@
"type": "string"
},
{
- "description": "name of the group or OU in LDAP",
+ "description": "Type of the account to auto import. Specify 0 for user and 2 for domain admin",
"length": 255,
- "name": "name",
- "required": false,
- "type": "string"
+ "name": "accounttype",
+ "required": true,
+ "type": "short"
},
{
"description": "type of the ldap name. GROUP or OU",
@@ -55344,26 +55928,7 @@
],
"related": "linkAccountToLdap",
"response": [
- {
- "description": "Domain Admin accountId that is created",
- "name": "accountid",
- "type": "string"
- },
- {
- "description": "Type of the account to auto import",
- "name": "accounttype",
- "type": "short"
- },
- {
- "description": "id of the Domain which is linked to LDAP",
- "name": "domainid",
- "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",
@@ -55374,7 +55939,21 @@
"name": "name",
"type": "string"
},
- {},
+ {
+ "description": "Domain Admin accountId that is created",
+ "name": "accountid",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
{},
{
"description": "type of the name in LDAP which is linke to the domain",
@@ -55382,9 +55961,14 @@
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "id of the Domain which is linked to LDAP",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "Type of the account to auto import",
+ "name": "accounttype",
+ "type": "short"
}
],
"since": "4.6.0"
@@ -55395,11 +55979,20 @@
"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": "Deploy VM for the project",
"length": 255,
- "name": "isportable",
+ "name": "projectid",
+ "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject",
"required": false,
- "type": "boolean"
+ "type": "uuid"
+ },
+ {
+ "description": "region ID from where portable IP is to be associated.",
+ "length": 255,
+ "name": "regionid",
+ "related": "addRegion,listRegions",
+ "required": false,
+ "type": "integer"
},
{
"description": "an optional field, whether to the display the IP to the end user or not",
@@ -55410,14 +56003,6 @@
"type": "boolean"
},
{
- "description": "the ID of the domain to associate with this IP address",
- "length": 255,
- "name": "domainid",
- "related": "listDomainChildren,listDomains",
- "required": false,
- "type": "uuid"
- },
- {
"description": "the account to associate with this IP address",
"length": 255,
"name": "account",
@@ -55432,14 +56017,21 @@
"type": "string"
},
{
- "description": "Deploy VM for the project",
+ "description": "the VPC you want the IP address to be associated with",
"length": 255,
- "name": "projectid",
- "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject",
+ "name": "vpcid",
+ "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC",
"required": false,
"type": "uuid"
},
{
+ "description": "should be set to true if public IP is required to be transferable across zones, if not specified defaults to false",
+ "length": 255,
+ "name": "isportable",
+ "required": false,
+ "type": "boolean"
+ },
+ {
"description": "The network this IP address should be associated to.",
"length": 255,
"name": "networkid",
@@ -55448,135 +56040,43 @@
"type": "uuid"
},
{
- "description": "region ID from where portable IP is to be associated.",
- "length": 255,
- "name": "regionid",
- "related": "addRegion,listRegions",
- "required": false,
- "type": "integer"
- },
- {
- "description": "the VPC you want the IP address to be associated with",
- "length": 255,
- "name": "vpcid",
- "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC",
- "required": false,
- "type": "uuid"
- },
- {
"description": "the ID of the availability zone you want to acquire an public IP address from",
"length": 255,
"name": "zoneid",
"related": "createZone,updateZone,listZones,listZones",
"required": false,
"type": "uuid"
+ },
+ {
+ "description": "the ID of the domain to associate with this IP address",
+ "length": 255,
+ "name": "domainid",
+ "related": "listDomainChildren,listDomains",
+ "required": false,
+ "type": "uuid"
}
],
"related": "updateIpAddress,associateIpAddress,listPublicIpAddresses",
"response": [
{
- "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only",
- "name": "vlanid",
- "type": "string"
+ "description": "true if the IP address is a source nat address, false otherwise",
+ "name": "issourcenat",
+ "type": "boolean"
},
{
- "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 name of the Network where ip belongs to",
"name": "networkname",
"type": "string"
},
+ {},
{
- "description": "the ID of the zone the public IP address belongs to",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "State of the ip address. Can be: Allocatin, Allocated and Releasing",
- "name": "state",
- "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",
- "name": "associatednetworkname",
- "type": "string"
- },
- {
- "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)",
- "name": "virtualmachinedisplayname",
- "type": "string"
- },
- {
- "description": "the ID of the Network associated with the IP address",
- "name": "associatednetworkid",
- "type": "string"
- },
- {
- "description": "virtual machine (dnat) ip address (not null only for static nat Ip)",
- "name": "vmipaddress",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the project id of the ipaddress",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "public IP address",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "description": "the domain ID the public IP address is associated with",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value",
- "name": "purpose",
- "type": "string"
- },
- {
- "description": "the project name of the address",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the virtual network for the IP address",
- "name": "forvirtualnetwork",
- "type": "boolean"
- },
- {
- "description": "the account the public IP address is associated with",
- "name": "account",
- "type": "string"
- },
- {
- "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)",
- "name": "issystem",
- "type": "boolean"
- },
- {
- "description": "the 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",
+ "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only",
+ "name": "vlanid",
"type": "string"
},
{
@@ -55585,40 +56085,44 @@
"type": "boolean"
},
{
- "description": "the domain the public IP address is associated with",
- "name": "domain",
+ "description": "virtual machine name the ip address is assigned to (not null only for static nat Ip)",
+ "name": "virtualmachinename",
"type": "string"
},
{
- "description": "true if the IP address is a source nat address, false otherwise",
- "name": "issourcenat",
- "type": "boolean"
- },
- {},
- {
- "description": "date the public IP address was acquired",
- "name": "allocated",
- "type": "date"
- },
- {},
- {
- "description": "the VLAN associated with the IP address",
- "name": "vlanname",
+ "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)",
+ "name": "virtualmachinedisplayname",
"type": "string"
},
+ {},
{
"description": "the physical network this belongs to",
"name": "physicalnetworkid",
"type": "string"
},
{
- "description": "public IP address id",
- "name": "id",
+ "description": "true if this ip is for static nat, false otherwise",
+ "name": "isstaticnat",
+ "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": "virtual machine name the ip address is assigned to (not null only for static nat Ip)",
- "name": "virtualmachinename",
+ "description": "VPC name the ip belongs to",
+ "name": "vpcname",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the Network where ip belongs to",
+ "name": "networkid",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID the public IP address is associated with",
+ "name": "domainid",
"type": "string"
},
{
@@ -55627,16 +56131,101 @@
"type": "string"
},
{
+ "description": "the name of the Network associated with the IP address",
+ "name": "associatednetworkname",
+ "type": "string"
+ },
+ {
+ "description": "the account the public IP address is associated with",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "public IP address id",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the Network associated with the IP address",
+ "name": "associatednetworkid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the zone the public IP address belongs to",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "the project id of the ipaddress",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "virtual machine (dnat) ip address (not null only for static nat Ip)",
+ "name": "vmipaddress",
+ "type": "string"
+ },
+ {
+ "description": "the virtual network for the IP address",
+ "name": "forvirtualnetwork",
+ "type": "boolean"
+ },
+ {
+ "description": "public IP address",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "the VLAN associated with the IP address",
+ "name": "vlanname",
+ "type": "string"
+ },
+ {
+ "description": "is public IP portable across the zones",
+ "name": "isportable",
+ "type": "boolean"
+ },
+ {
"description": "true if the entity/resource has annotations",
"name": "hasannotations",
"type": "boolean"
},
{
- "description": "VPC name the ip belongs to",
- "name": "vpcname",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
+ "description": "the ID of the zone the public IP address belongs to",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the address",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the domain the public IP address is associated with",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "State of the ip address. Can be: Allocatin, Allocated and Releasing",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)",
+ "name": "issystem",
+ "type": "boolean"
+ },
+ {
"description": "the list of resource tags associated with ip address",
"name": "tags",
"response": [
@@ -55646,13 +56235,8 @@
"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": "the domain associated with the tag",
+ "name": "domain",
"type": "string"
},
{
@@ -55661,13 +56245,28 @@
"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": "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"
},
{
@@ -55676,29 +56275,14 @@
"type": "string"
},
{
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
"description": "customer associated with the tag",
"name": "customer",
"type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
}
],
"type": "list"
},
{
- "description": "is public IP portable across the zones",
- "name": "isportable",
- "type": "boolean"
- },
- {
"description": "VPC id the ip belongs to",
"name": "vpcid",
"type": "string"
@@ -55728,22 +56312,22 @@
"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"
- }
+ {}
]
},
{
@@ -55762,27 +56346,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": "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"
+ },
+ {},
+ {}
]
},
{
@@ -55801,26 +56385,26 @@
],
"response": [
{
- "description": "any text associated with the success or failure",
- "name": "displaytext",
- "type": "string"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
+ {},
{
"description": "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"
}
]
},
@@ -55830,6 +56414,36 @@
"name": "createNetworkACL",
"params": [
{
+ "description": "the ending port of ACL",
+ "length": 255,
+ "name": "endport",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "an optional field, whether to the display the rule to the end user or not",
+ "length": 255,
+ "name": "fordisplay",
+ "required": false,
+ "since": "4.4",
+ "type": "boolean"
+ },
+ {
+ "description": "the starting port of ACL",
+ "length": 255,
+ "name": "startport",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "The network of the VM the ACL will be created for",
+ "length": 255,
+ "name": "aclid",
+ "related": "createNetworkACLList",
+ "required": false,
+ "type": "uuid"
+ },
+ {
"description": "error code for this ICMP message",
"length": 255,
"name": "icmpcode",
@@ -55844,18 +56458,12 @@
"type": "list"
},
{
- "description": "scl entry action, allow or deny",
+ "description": "The network of the VM the ACL will be created for",
"length": 255,
- "name": "action",
+ "name": "networkid",
+ "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks",
"required": false,
- "type": "string"
- },
- {
- "description": "the ending port of ACL",
- "length": 255,
- "name": "endport",
- "required": false,
- "type": "integer"
+ "type": "uuid"
},
{
"description": "The number of the ACL item, its ordering",
@@ -55865,12 +56473,11 @@
"type": "integer"
},
{
- "description": "The network of the VM the ACL will be created for",
+ "description": "scl entry action, allow or deny",
"length": 255,
- "name": "aclid",
- "related": "createNetworkACLList",
+ "name": "action",
"required": false,
- "type": "uuid"
+ "type": "string"
},
{
"description": "A description indicating why the ACL rule is required.",
@@ -55880,20 +56487,6 @@
"type": "string"
},
{
- "description": "type of the ICMP message being sent",
- "length": 255,
- "name": "icmptype",
- "required": false,
- "type": "integer"
- },
- {
- "description": "the starting port of ACL",
- "length": 255,
- "name": "startport",
- "required": false,
- "type": "integer"
- },
- {
"description": "the traffic type for the ACL,can be ingress or egress, defaulted to ingress if not specified",
"length": 255,
"name": "traffictype",
@@ -55901,61 +56494,23 @@
"type": "string"
},
{
- "description": "an optional field, whether to the display the rule to the end user or not",
- "length": 255,
- "name": "fordisplay",
- "required": false,
- "since": "4.4",
- "type": "boolean"
- },
- {
- "description": "The network of the VM the ACL will be created for",
- "length": 255,
- "name": "networkid",
- "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks",
- "required": false,
- "type": "uuid"
- },
- {
"description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number",
"length": 255,
"name": "protocol",
"required": true,
"type": "string"
+ },
+ {
+ "description": "type of the ICMP message being sent",
+ "length": 255,
+ "name": "icmptype",
+ "required": false,
+ "type": "integer"
}
],
"related": "updateNetworkACLItem,moveNetworkAclItem",
"response": [
- {
- "description": "Number of the ACL Item",
- "name": "number",
- "type": "integer"
- },
- {
- "description": "an explanation on why this ACL rule is being applied",
- "name": "reason",
- "type": "string"
- },
- {
- "description": "the state of the rule",
- "name": "state",
- "type": "string"
- },
- {
- "description": "the protocol of the ACL",
- "name": "protocol",
- "type": "string"
- },
- {
- "description": "Action of ACL Item. Allow/Deny",
- "name": "action",
- "type": "string"
- },
- {
- "description": "the traffic type for the ACL",
- "name": "traffictype",
- "type": "string"
- },
+ {},
{
"description": "the ID of the ACL Item",
"name": "id",
@@ -55967,24 +56522,23 @@
"type": "string"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the name of the ACL this item belongs to",
+ "name": "aclname",
"type": "string"
},
{
- "description": "the ID of the ACL this item belongs to",
- "name": "aclid",
+ "description": "the starting port of ACL's port range",
+ "name": "startport",
"type": "string"
},
- {},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
+ "description": "Number of the ACL Item",
+ "name": "number",
"type": "integer"
},
{
- "description": "the 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"
},
{
@@ -55993,40 +56547,56 @@
"type": "integer"
},
{
+ "description": "the state of the rule",
+ "name": "state",
+ "type": "string"
+ },
+ {
"description": "error code for this icmp message",
"name": "icmpcode",
"type": "integer"
},
{
+ "description": "an explanation on why this ACL rule is being applied",
+ "name": "reason",
+ "type": "string"
+ },
+ {
+ "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 protocol of the ACL",
+ "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 network ACLs",
"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": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
"description": "tag value",
"name": "value",
"type": "string"
@@ -56037,18 +56607,38 @@
"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": "customer associated with the tag",
- "name": "customer",
+ "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"
}
],
@@ -56060,14 +56650,8 @@
"type": "boolean"
},
{
- "description": "the starting port of ACL's port range",
- "name": "startport",
- "type": "string"
- },
- {},
- {
- "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).",
- "name": "cidrlist",
+ "description": "the traffic type for the ACL",
+ "name": "traffictype",
"type": "string"
}
]
@@ -56078,6 +56662,20 @@
"name": "resetSSHKeyForVirtualMachine",
"params": [
{
+ "description": "an optional account for the ssh key. Must be used with domainId.",
+ "length": 255,
+ "name": "account",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "name of the ssh key pair used to login to the virtual machine",
+ "length": 255,
+ "name": "keypair",
+ "required": true,
+ "type": "string"
+ },
+ {
"description": "an optional project for the ssh key",
"length": 255,
"name": "projectid",
@@ -56086,13 +56684,6 @@
"type": "uuid"
},
{
- "description": "an optional account for the ssh key. Must be used with domainId.",
- "length": 255,
- "name": "account",
- "required": false,
- "type": "string"
- },
- {
"description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.",
"length": 255,
"name": "domainid",
@@ -56101,13 +56692,6 @@
"type": "uuid"
},
{
- "description": "name of the ssh key pair used to login to the virtual machine",
- "length": 255,
- "name": "keypair",
- "required": true,
- "type": "string"
- },
- {
"description": "The ID of the virtual machine",
"length": 255,
"name": "id",
@@ -56119,13 +56703,367 @@
"related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance",
"response": [
{
- "description": "the read (io) of disk on the vm",
- "name": "diskioread",
+ "description": "the incoming network traffic on the vm",
+ "name": "networkkbsread",
"type": "long"
},
{
- "description": "the user's ID who deployed the virtual machine",
- "name": "userid",
+ "description": "the ID of the host for the virtual machine",
+ "name": "hostid",
+ "type": "string"
+ },
+ {
+ "description": "the read (bytes) of disk on the vm",
+ "name": "diskkbsread",
+ "type": "long"
+ },
+ {
+ "description": "the memory allocated for the virtual machine",
+ "name": "memory",
+ "type": "integer"
+ },
+ {
+ "description": "instance name of the user vm; this parameter is returned to the ROOT admin only",
+ "name": "instancename",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the availablility zone for the virtual machine",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "ssh key-pair",
+ "name": "keypair",
+ "type": "string"
+ },
+ {
+ "description": "the name of the ISO attached to the virtual machine",
+ "name": "isoname",
+ "type": "string"
+ },
+ {
+ "description": "the target memory in vm",
+ "name": "memorytargetkbs",
+ "type": "long"
+ },
+ {
+ "description": "Os type ID of the virtual machine",
+ "name": "guestosid",
+ "type": "string"
+ },
+ {
+ "description": "the write (bytes) of disk on the vm",
+ "name": "diskkbswrite",
+ "type": "long"
+ },
+ {
+ "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 ID of the domain in which the virtual machine exists",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the ISO attached to the virtual machine",
+ "name": "isoid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the disk offering of the virtual machine",
+ "name": "diskofferingname",
+ "type": "string"
+ },
+ {
+ "description": "the number of cpu this virtual machine is running with",
+ "name": "cpunumber",
+ "type": "integer"
+ },
+ {
+ "description": "the date when this virtual machine was updated last time",
+ "name": "lastupdated",
+ "type": "date"
+ },
+ {
+ "description": "true if high-availability is enabled, false otherwise",
+ "name": "haenable",
+ "type": "boolean"
+ },
+ {
+ "description": "the amount of the vm's CPU currently used",
+ "name": "cpuused",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the account associated with the virtual machine",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "Guest vm Boot Mode",
+ "name": "bootmode",
+ "type": "string"
+ },
+ {
+ "description": "the outgoing network traffic on the host",
+ "name": "networkkbswrite",
+ "type": "long"
+ },
+ {
+ "description": "the internal memory that's free in vm or zero if it can not be calculated",
+ "name": "memoryintfreekbs",
+ "type": "long"
+ },
+ {
+ "description": "the name of the availability zone for the virtual machine",
+ "name": "zonename",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the virtual network for the service offering",
+ "name": "forvirtualnetwork",
+ "type": "boolean"
+ },
+ {
+ "description": "the project name of the vm",
+ "name": "project",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the list of nics associated with vm",
+ "name": "nic",
+ "response": [
+ {
+ "description": "Id of the vm to which the nic belongs",
+ "name": "virtualmachineid",
+ "type": "string"
+ },
+ {
+ "description": "Type of adapter if available",
+ "name": "adaptertype",
+ "type": "string"
+ },
+ {
+ "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise",
+ "name": "nsxlogicalswitchport",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the corresponding network",
+ "name": "networkid",
+ "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 broadcast uri of the nic",
+ "name": "broadcasturi",
+ "type": "string"
+ },
+ {
+ "description": "Id of the NSX Logical Switch (if NSX based), null otherwise",
+ "name": "nsxlogicalswitch",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the nic",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the gateway of the nic",
+ "name": "gateway",
+ "type": "string"
+ },
+ {
+ "description": "IP addresses associated with NIC found for unmanaged VM",
+ "name": "ipaddresses",
+ "type": "list"
+ },
+ {
+ "description": "the ip address of the nic",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "the isolated private VLAN type if available",
+ "name": "isolatedpvlantype",
+ "type": "string"
+ },
+ {
+ "description": "device id for the network when plugged into the virtual machine",
+ "name": "deviceid",
+ "type": "string"
+ },
+ {
+ "description": "the isolation uri of the nic",
+ "name": "isolationuri",
+ "type": "string"
+ },
+ {
+ "description": "the IPv6 address of network",
+ "name": "ip6address",
+ "type": "string"
+ },
+ {
+ "description": "true if nic is default, false otherwise",
+ "name": "macaddress",
+ "type": "string"
+ },
+ {
+ "description": "the 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 traffic type of the nic",
+ "name": "traffictype",
+ "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 isolated private VLAN if available",
+ "name": "isolatedpvlan",
+ "type": "integer"
+ },
+ {
+ "description": "ID of the VLAN/VNI if available",
+ "name": "vlanid",
+ "type": "integer"
+ },
+ {
+ "description": "the cidr of IPv6 network",
+ "name": "ip6cidr",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "description": "the project id of the vm",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "State of the Service from LB rule",
+ "name": "servicestate",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the virtual machine",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the name of the virtual machine",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the memory used by the vm",
+ "name": "memorykbs",
+ "type": "long"
+ },
+ {
+ "description": "the password (if exists) of the virtual machine",
+ "name": "password",
+ "type": "string"
+ },
+ {
+ "description": "public IP address id associated with vm via Static nat rule",
+ "name": "publicip",
+ "type": "string"
+ },
+ {
+ "description": "the name of the template for the virtual machine",
+ "name": "templatename",
+ "type": "string"
+ },
+ {
+ "description": "the date when this virtual machine was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "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 ID of the service offering of the virtual machine",
+ "name": "serviceofferingid",
+ "type": "string"
+ },
+ {
+ "description": "the speed of each cpu",
+ "name": "cpuspeed",
+ "type": "integer"
+ },
+ {
+ "description": "an optional field whether to the display the vm to the end user or not.",
+ "name": "displayvm",
+ "type": "boolean"
+ },
+ {
+ "description": "the name of the domain in which the virtual machine exists",
+ "name": "domain",
"type": "string"
},
{
@@ -56133,293 +57071,273 @@
"name": "securitygroup",
"response": [
{
- "description": "the account owning the security group",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the project name of the group",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the list of egress rules associated with the security group",
- "name": "egressrule",
- "response": [
- {
- "description": "the type of the ICMP message response",
- "name": "icmptype",
- "type": "integer"
- },
- {
- "description": "the list of resource tags associated with the rule",
- "name": "tags",
- "response": [
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "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": "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 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 starting IP of the security group rule",
- "name": "startport",
- "type": "integer"
- },
- {
- "description": "the ending IP of the security group rule ",
- "name": "endport",
- "type": "integer"
- },
- {
- "description": "account owning the security group rule",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the 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 name of the security group",
"name": "name",
"type": "string"
},
{
- "description": "the domain name of the security group",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the project id of the group",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the number of virtualmachines associated with this securitygroup",
- "name": "virtualmachinecount",
- "type": "integer"
- },
- {
- "description": "the list of ingress rules associated with the security group",
- "name": "ingressrule",
- "response": [
- {
- "description": "the type of the ICMP message response",
- "name": "icmptype",
- "type": "integer"
- },
- {
- "description": "the ending IP of the security group rule ",
- "name": "endport",
- "type": "integer"
- },
- {
- "description": "the 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 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": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "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"
- }
- ],
- "type": "set"
- },
- {
- "description": "security group name",
- "name": "securitygroupname",
- "type": "string"
- },
- {
- "description": "the id of the security group rule",
- "name": "ruleid",
- "type": "string"
- },
- {
- "description": "the code for the ICMP message response",
- "name": "icmpcode",
- "type": "integer"
- },
- {
- "description": "the protocol of the security group rule",
- "name": "protocol",
- "type": "string"
- },
- {
- "description": "account owning the security group rule",
- "name": "account",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
"description": "the list of virtualmachine ids associated with this securitygroup",
"name": "virtualmachineids",
"type": "set"
},
{
+ "description": "the number of virtualmachines associated with this securitygroup",
+ "name": "virtualmachinecount",
+ "type": "integer"
+ },
+ {
+ "description": "the domain name of the security group",
+ "name": "domain",
+ "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 protocol of the security group rule",
+ "name": "protocol",
+ "type": "string"
+ },
+ {
+ "description": "the type of the ICMP message response",
+ "name": "icmptype",
+ "type": "integer"
+ },
+ {
+ "description": "the list of resource tags associated with the rule",
+ "name": "tags",
+ "response": [
+ {
+ "description": "the 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 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": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the CIDR notation for the base IP address of the security group rule",
+ "name": "cidr",
+ "type": "string"
+ },
+ {
+ "description": "the ending IP of the security group rule ",
+ "name": "endport",
+ "type": "integer"
+ },
+ {
+ "description": "account owning the security group rule",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the starting IP of the security group rule",
+ "name": "startport",
+ "type": "integer"
+ },
+ {
+ "description": "the id of the security group rule",
+ "name": "ruleid",
+ "type": "string"
+ },
+ {
+ "description": "the code for the ICMP message response",
+ "name": "icmpcode",
+ "type": "integer"
+ },
+ {
+ "description": "security group name",
+ "name": "securitygroupname",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the project name of the group",
+ "name": "project",
+ "type": "string"
+ },
+ {
"description": "the description of the security group",
"name": "description",
"type": "string"
},
{
+ "description": "the domain ID of the security group",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the list of egress rules associated with the security group",
+ "name": "egressrule",
+ "response": [
+ {
+ "description": "the id of the security group rule",
+ "name": "ruleid",
+ "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": "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 ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the CIDR notation for the base IP address of the security group rule",
+ "name": "cidr",
+ "type": "string"
+ },
+ {
+ "description": "the starting IP of the security group rule",
+ "name": "startport",
+ "type": "integer"
+ },
+ {
+ "description": "the protocol of the security group rule",
+ "name": "protocol",
+ "type": "string"
+ },
+ {
+ "description": "the code for the ICMP message response",
+ "name": "icmpcode",
+ "type": "integer"
+ },
+ {
+ "description": "the 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": "account owning the security group rule",
+ "name": "account",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the account owning the security group",
+ "name": "account",
+ "type": "string"
+ },
+ {
"description": "the list of 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": "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"
@@ -56430,18 +57348,38 @@
"type": "string"
},
{
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
"description": "customer associated with the tag",
"name": "customer",
"type": "string"
},
{
+ "description": "tag 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",
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
"type": "string"
},
{
@@ -56453,27 +57391,62 @@
"type": "set"
},
{
- "description": "the ID of the security group",
- "name": "id",
+ "description": "the project id of the group",
+ "name": "projectid",
"type": "string"
}
],
"type": "set"
},
- {
- "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",
+ "description": "the pool type of the virtual machine",
+ "name": "pooltype",
+ "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",
+ "name": "publicipid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the service offering of the virtual machine",
+ "name": "serviceofferingname",
+ "type": "string"
+ },
+ {
+ "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.",
+ "name": "isdynamicallyscalable",
+ "type": "boolean"
+ },
+ {
+ "description": "the 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",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.",
+ "name": "templateid",
+ "type": "string"
+ },
+ {
+ "description": "Guest vm Boot Type",
+ "name": "boottype",
+ "type": "string"
+ },
+ {
+ "description": "the state of the virtual machine",
+ "name": "state",
"type": "string"
},
{
@@ -56482,37 +57455,27 @@
"type": "string"
},
{
- "description": "the ID of the domain in which the virtual machine exists",
- "name": "domainid",
+ "description": "the group name of the virtual machine",
+ "name": "group",
"type": "string"
},
{
- "description": "the ID of the virtual machine",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the target memory in vm",
- "name": "memorytargetkbs",
+ "description": "the read (io) of disk on the vm",
+ "name": "diskioread",
"type": "long"
},
{
- "description": "the name of the virtual machine",
- "name": "name",
- "type": "string"
- },
- {
"description": "list of affinity groups associated with the virtual machine",
"name": "affinitygroup",
"response": [
{
- "description": "the ID of the affinity group",
- "name": "id",
- "type": "string"
+ "description": "virtual machine IDs associated with this affinity group",
+ "name": "virtualmachineIds",
+ "type": "list"
},
{
- "description": "the description of the affinity group",
- "name": "description",
+ "description": "the domain ID of the affinity group",
+ "name": "domainid",
"type": "string"
},
{
@@ -56521,23 +57484,8 @@
"type": "string"
},
{
- "description": "the domain ID of the affinity group",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the project ID of the affinity group",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the domain name of the affinity group",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the type of the affinity group",
- "name": "type",
+ "description": "the description of the affinity group",
+ "name": "description",
"type": "string"
},
{
@@ -56546,40 +57494,110 @@
"type": "string"
},
{
- "description": "virtual machine IDs associated with this affinity group",
- "name": "virtualmachineIds",
- "type": "list"
+ "description": "the type of the affinity group",
+ "name": "type",
+ "type": "string"
+ },
+ {
+ "description": "the domain name of the affinity group",
+ "name": "domain",
+ "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 project ID of the affinity group",
+ "name": "projectid",
+ "type": "string"
}
],
"type": "set"
},
{
- "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.",
- "name": "isdynamicallyscalable",
- "type": "boolean"
+ "description": "the user's ID who deployed the virtual machine",
+ "name": "userid",
+ "type": "string"
},
{
- "description": "the group name of the virtual machine",
- "name": "group",
+ "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 ID of the disk offering of the virtual machine",
+ "name": "diskofferingid",
+ "type": "string"
+ },
+ {
+ "description": "user generated name. The name of the virtual machine is returned if no displayname exists.",
+ "name": "displayname",
+ "type": "string"
+ },
+ {
+ "description": "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",
+ "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": "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 key name",
"name": "key",
"type": "string"
},
{
- "description": "resource type",
- "name": "resourcetype",
+ "description": "tag value",
+ "name": "value",
+ "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"
},
{
@@ -56593,177 +57611,21 @@
"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 value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
}
],
"type": "set"
},
{
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "the name of the ISO attached to the virtual machine",
- "name": "isoname",
- "type": "string"
- },
- {
- "description": "the state of the virtual machine",
- "name": "state",
- "type": "string"
- },
- {
- "description": "the ID of the host for the virtual machine",
- "name": "hostid",
- "type": "string"
- },
- {
- "description": "Os type ID of the virtual machine",
- "name": "guestosid",
- "type": "string"
- },
- {
- "description": "ssh key-pair",
- "name": "keypair",
- "type": "string"
- },
- {
- "description": "the ID of the availablility zone for the virtual machine",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the virtual network for the service offering",
- "name": "forvirtualnetwork",
- "type": "boolean"
- },
- {
- "description": "the name of the host for the virtual machine",
- "name": "hostname",
- "type": "string"
- },
- {
- "description": "the speed of each cpu",
- "name": "cpuspeed",
- "type": "integer"
- },
- {
- "description": "the memory used by the vm",
- "name": "memorykbs",
- "type": "long"
- },
- {
- "description": "the name of the template for the virtual machine",
- "name": "templatename",
- "type": "string"
- },
- {
- "description": "the ID of the disk offering of the virtual machine",
- "name": "diskofferingid",
- "type": "string"
- },
- {
- "description": " an alternate display text of the template for the virtual machine",
- "name": "templatedisplaytext",
- "type": "string"
- },
- {
- "description": "State of the Service from LB rule",
- "name": "servicestate",
- "type": "string"
- },
- {},
- {
- "description": "the password (if exists) of the virtual machine",
- "name": "password",
- "type": "string"
- },
- {
- "description": "the date when this virtual machine was updated last time",
- "name": "lastupdated",
- "type": "date"
- },
- {
"description": "the total number of network traffic bytes sent",
"name": "sentbytes",
"type": "long"
},
{
- "description": "OS type id of the vm",
- "name": "ostypeid",
- "type": "string"
- },
- {
- "description": "the memory allocated for the virtual machine",
- "name": "memory",
- "type": "integer"
- },
- {
- "description": "the pool type of the virtual machine",
- "name": "pooltype",
- "type": "string"
- },
- {
- "description": "the ID of the ISO attached to the virtual machine",
- "name": "isoid",
- "type": "string"
- },
- {
- "description": "public IP address id associated with vm via Static nat rule",
- "name": "publicipid",
- "type": "string"
- },
- {
- "description": "the name of the backup offering of the virtual machine",
- "name": "backupofferingname",
- "type": "string"
- },
- {
- "description": "the account associated with the virtual machine",
- "name": "account",
- "type": "string"
- },
- {
- "description": "true if the password rest feature is enabled, false otherwise",
- "name": "passwordenabled",
- "type": "boolean"
- },
- {
- "description": "the incoming network traffic on the vm",
- "name": "networkkbsread",
- "type": "long"
- },
- {
- "description": "the ID of the service offering of the virtual machine",
- "name": "serviceofferingid",
+ "description": "List of read-only Vm details as comma separated string.",
+ "name": "readonlydetails",
"type": "string"
},
{
@@ -56772,302 +57634,24 @@
"type": "map"
},
{
- "description": "the total number of network traffic bytes received",
- "name": "receivedbytes",
+ "description": "the write (io) of disk on the vm",
+ "name": "diskiowrite",
"type": "long"
},
{
- "description": "the group ID of the virtual machine",
- "name": "groupid",
- "type": "string"
- },
- {
- "description": "the name of the domain in which the virtual machine exists",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "an optional field whether to the display the vm to the end user or not.",
- "name": "displayvm",
- "type": "boolean"
- },
- {
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
- },
- {
- "description": "the vgpu type used by the virtual machine",
- "name": "vgpu",
- "type": "string"
- },
- {
- "description": "the date when this virtual machine was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "Guest vm Boot Type",
- "name": "boottype",
- "type": "string"
- },
- {
- "description": "the read (bytes) of disk on the vm",
- "name": "diskkbsread",
- "type": "long"
- },
- {
- "description": "the number of cpu this virtual machine is running with",
- "name": "cpunumber",
- "type": "integer"
- },
- {
- "description": "the list of nics associated with vm",
- "name": "nic",
- "response": [
- {
- "description": "the traffic type of the nic",
- "name": "traffictype",
- "type": "string"
- },
- {
- "description": "the ID of the nic",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the isolation uri of the nic",
- "name": "isolationuri",
- "type": "string"
- },
- {
- "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise",
- "name": "nsxlogicalswitchport",
- "type": "string"
- },
- {
- "description": "the broadcast uri of the nic",
- "name": "broadcasturi",
- "type": "string"
- },
- {
- "description": "the netmask of the nic",
- "name": "netmask",
- "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 ID of the corresponding network",
- "name": "networkid",
- "type": "string"
- },
- {
- "description": "ID of the VLAN/VNI if available",
- "name": "vlanid",
- "type": "integer"
- },
- {
- "description": "the IPv6 address of network",
- "name": "ip6address",
- "type": "string"
- },
- {
- "description": "the extra dhcp options on the nic",
- "name": "extradhcpoption",
- "type": "list"
- },
- {
- "description": "the ip address of the nic",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "description": "true if nic is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
- },
- {
- "description": "Type of adapter if available",
- "name": "adaptertype",
- "type": "string"
- },
- {
- "description": "the gateway of IPv6 network",
- "name": "ip6gateway",
- "type": "string"
- },
- {
- "description": "the isolated private VLAN if available",
- "name": "isolatedpvlan",
- "type": "integer"
- },
- {
- "description": "the isolated private VLAN type if available",
- "name": "isolatedpvlantype",
- "type": "string"
- },
- {
- "description": "the Secondary ipv4 addr of nic",
- "name": "secondaryip",
- "type": "list"
- },
- {
- "description": "Id of the vm to which the nic belongs",
- "name": "virtualmachineid",
- "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 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": "true if nic is default, false otherwise",
- "name": "macaddress",
- "type": "string"
- },
- {
- "description": "device id for the network when plugged into the virtual machine",
- "name": "deviceid",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the outgoing network traffic on the host",
- "name": "networkkbswrite",
- "type": "long"
- },
- {
- "description": "the user's name who deployed the virtual machine",
- "name": "username",
- "type": "string"
- },
- {
- "description": "OS name of the vm",
- "name": "osdisplayname",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "device ID of the root volume",
- "name": "rootdeviceid",
- "type": "long"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
"description": "the hypervisor on which the template runs",
"name": "hypervisor",
"type": "string"
},
{
- "description": "true if high-availability is enabled, false otherwise",
- "name": "haenable",
- "type": "boolean"
- },
- {
- "description": "the ID of the backup offering of the virtual machine",
- "name": "backupofferingid",
- "type": "string"
- },
- {
- "description": "the amount of the vm's CPU currently used",
- "name": "cpuused",
- "type": "string"
- },
- {
- "description": "the project name of the vm",
- "name": "project",
- "type": "string"
- },
- {
- "description": "List of read-only Vm details as comma separated string.",
- "name": "readonlydetails",
- "type": "string"
+ "description": "the total number of network traffic bytes received",
+ "name": "receivedbytes",
+ "type": "long"
},
{
"description": "an alternate display text of the ISO attached to the virtual machine",
"name": "isodisplaytext",
"type": "string"
- },
- {
- "description": "user generated name. The name of the virtual machine is returned if no displayname exists.",
- "name": "displayname",
- "type": "string"
- },
- {
- "description": "the name of the disk offering of the virtual machine",
- "name": "diskofferingname",
- "type": "string"
- },
- {
- "description": "the write (bytes) of disk on the vm",
- "name": "diskkbswrite",
- "type": "long"
- },
- {},
- {
- "description": "Guest vm Boot Mode",
- "name": "bootmode",
- "type": "string"
- },
- {
- "description": "the internal memory that's free in vm or zero if it can not be calculated",
- "name": "memoryintfreekbs",
- "type": "long"
- },
- {
- "description": "the name of the service offering of the virtual machine",
- "name": "serviceofferingname",
- "type": "string"
- },
- {
- "description": "the project id of the vm",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the write (io) of disk on the vm",
- "name": "diskiowrite",
- "type": "long"
- },
- {
- "description": "the 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"
}
]
},
@@ -57077,16 +57661,45 @@
"name": "listVpnCustomerGateways",
"params": [
{
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false",
+ "length": 255,
+ "name": "listall",
+ "required": false,
+ "type": "boolean"
+ },
+ {
"description": "",
"length": 255,
- "name": "page",
+ "name": "pagesize",
"required": false,
"type": "integer"
},
{
- "description": "List by keyword",
+ "description": "list only resources belonging to the domain specified",
"length": 255,
- "name": "keyword",
+ "name": "domainid",
+ "related": "listDomainChildren,listDomains",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
+ "length": 255,
+ "name": "isrecursive",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "list resources by account. Must be used with the domainId parameter.",
+ "length": 255,
+ "name": "account",
"required": false,
"type": "string"
},
@@ -57099,27 +57712,6 @@
"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.",
- "length": 255,
- "name": "isrecursive",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "",
- "length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
- },
- {
"description": "list objects by project",
"length": 255,
"name": "projectid",
@@ -57128,123 +57720,34 @@
"type": "uuid"
},
{
- "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false",
+ "description": "",
"length": 255,
- "name": "listall",
+ "name": "page",
"required": false,
- "type": "boolean"
- },
- {
- "description": "list only resources belonging to the domain specified",
- "length": 255,
- "name": "domainid",
- "related": "listDomainChildren,listDomains",
- "required": false,
- "type": "uuid"
+ "type": "integer"
}
],
"related": "createVpnCustomerGateway",
"response": [
- {
- "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).",
- "name": "cidrlist",
- "type": "string"
- },
- {
- "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike",
- "name": "ikeversion",
- "type": "string"
- },
- {
- "description": "the domain name of the owner",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "Lifetime of IKE SA of customer gateway",
- "name": "ikelifetime",
- "type": "long"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "name of the customer gateway",
- "name": "name",
- "type": "string"
- },
{},
{
- "description": "the project id",
- "name": "projectid",
+ "description": "public ip address id of the customer gateway",
+ "name": "gateway",
"type": "string"
},
{
- "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.",
- "name": "splitconnections",
- "type": "boolean"
- },
- {
- "description": "IPsec policy of customer gateway",
- "name": "esppolicy",
- "type": "string"
- },
- {
- "description": "the project name",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the owner",
- "name": "account",
- "type": "string"
- },
- {
- "description": "IKE policy of customer gateway",
- "name": "ikepolicy",
- "type": "string"
- },
- {
- "description": "if Force NAT Encapsulation is enabled for customer gateway",
- "name": "forceencap",
- "type": "boolean"
- },
- {
- "description": "the date and time the host was removed",
- "name": "removed",
- "type": "date"
- },
- {
- "description": "Lifetime of ESP SA of customer gateway",
- "name": "esplifetime",
- "type": "long"
- },
- {},
- {
- "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 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"
},
{
@@ -57253,14 +57756,95 @@
"type": "string"
},
{
+ "description": "if Force NAT Encapsulation is enabled for customer gateway",
+ "name": "forceencap",
+ "type": "boolean"
+ },
+ {
"description": "guest ip of the customer gateway",
"name": "ipaddress",
"type": "string"
},
{
+ "description": "the project id",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "Lifetime of ESP SA of customer gateway",
+ "name": "esplifetime",
+ "type": "long"
+ },
+ {
"description": "IPsec preshared-key of customer gateway",
"name": "ipsecpsk",
"type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the vpn gateway ID",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the project name",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "IPsec policy of customer gateway",
+ "name": "esppolicy",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.",
+ "name": "splitconnections",
+ "type": "boolean"
+ },
+ {
+ "description": "Lifetime of IKE SA of customer gateway",
+ "name": "ikelifetime",
+ "type": "long"
+ },
+ {
+ "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike",
+ "name": "ikeversion",
+ "type": "string"
+ },
+ {
+ "description": "IKE policy of customer gateway",
+ "name": "ikepolicy",
+ "type": "string"
+ },
+ {
+ "description": "the date and time the host was removed",
+ "name": "removed",
+ "type": "date"
+ },
+ {
+ "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).",
+ "name": "cidrlist",
+ "type": "string"
+ },
+ {
+ "description": "the domain name of the owner",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the owner",
+ "name": "account",
+ "type": "string"
}
]
},
@@ -57270,12 +57854,11 @@
"name": "deleteManagementNetworkIpRange",
"params": [
{
- "description": "UUID of POD, where the IP range belongs to.",
+ "description": "The starting IP address.",
"length": 255,
- "name": "podid",
- "related": "updatePod,createManagementNetworkIpRange",
+ "name": "startip",
"required": true,
- "type": "uuid"
+ "type": "string"
},
{
"description": "The vlan id the ip range sits on",
@@ -57285,32 +57868,204 @@
"type": "string"
},
{
- "description": "The starting IP address.",
- "length": 255,
- "name": "startip",
- "required": true,
- "type": "string"
- },
- {
"description": "The ending IP address.",
"length": 255,
"name": "endip",
"required": true,
"type": "string"
+ },
+ {
+ "description": "UUID of POD, where the IP range belongs to.",
+ "length": 255,
+ "name": "podid",
+ "related": "updatePod,createManagementNetworkIpRange",
+ "required": true,
+ "type": "uuid"
}
],
"response": [
+ {},
+ {},
+ {
+ "description": "true if operation is executed successfully",
+ "name": "success",
+ "type": "boolean"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
{
"description": "any text associated with the success or failure",
"name": "displaytext",
"type": "string"
+ }
+ ],
+ "since": "4.11.0.0"
+ },
+ {
+ "description": "Add a supported Kubernetes version",
+ "isasync": false,
+ "name": "addKubernetesSupportedVersion",
+ "params": [
+ {
+ "description": "the name of the Kubernetes supported version",
+ "length": 255,
+ "name": "name",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the minimum RAM size in MB to be set with the Kubernetes version",
+ "length": 255,
+ "name": "minmemory",
+ "required": true,
+ "type": "integer"
+ },
+ {
+ "description": "the 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 URL of the binaries ISO for Kubernetes supported version",
+ "length": 255,
+ "name": "url",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the minimum number of CPUs to be set with the Kubernetes version",
+ "length": 255,
+ "name": "mincpunumber",
+ "required": true,
+ "type": "integer"
+ },
+ {
+ "description": "the ID of the zone in which Kubernetes supported version will be available",
+ "length": 255,
+ "name": "zoneid",
+ "related": "createZone,updateZone,listZones,listZones",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "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 \"{<algorithm>}\", not including the double quotes. In this <algorithm> is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.",
+ "length": 255,
+ "name": "checksum",
+ "required": false,
+ "type": "string"
+ }
+ ],
+ "related": "listKubernetesSupportedVersions,updateKubernetesSupportedVersion",
+ "response": [
+ {
+ "description": "the enabled or disabled state of the Kubernetes supported version",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "the minimum number of CPUs needed for the Kubernetes supported version",
+ "name": "mincpunumber",
+ "type": "integer"
+ },
+ {
+ "description": "the state of the binaries ISO for Kubernetes supported version",
+ "name": "isostate",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the zone in which Kubernetes supported version is available",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "the id of the zone in which Kubernetes supported version is available",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "whether Kubernetes supported version supports HA, multi-control nodes",
+ "name": "supportsha",
+ "type": "boolean"
+ },
+ {
+ "description": "Name of the Kubernetes supported version",
+ "name": "name",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the id of the Kubernetes supported version",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the name of the binaries ISO for Kubernetes supported version",
+ "name": "isoname",
+ "type": "string"
},
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
- {},
+ {
+ "description": "the 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": "Kubernetes semantic version",
+ "name": "semanticversion",
+ "type": "string"
+ },
+ {
+ "description": "the id of the binaries ISO for Kubernetes supported version",
+ "name": "isoid",
+ "type": "string"
+ },
+ {}
+ ]
+ },
+ {
+ "description": "Deletes a Kubernetes cluster",
+ "isasync": true,
+ "name": "deleteKubernetesCluster",
+ "params": [
+ {
+ "description": "the ID of the Kubernetes cluster",
+ "length": 255,
+ "name": "id",
+ "related": "createKubernetesCluster,startKubernetesCluster,upgradeKubernetesCluster",
+ "required": true,
+ "type": "uuid"
+ }
+ ],
+ "response": [
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
{
"description": "true if operation is executed successfully",
"name": "success",
@@ -57318,12 +58073,17 @@
},
{},
{
+ "description": "any text associated with the success or failure",
+ "name": "displaytext",
+ "type": "string"
+ },
+ {},
+ {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
}
- ],
- "since": "4.11.0.0"
+ ]
},
{
"description": "Creates a global load balancer rule",
@@ -57331,25 +58091,10 @@
"name": "createGlobalLoadBalancerRule",
"params": [
{
- "description": "the domain ID associated with the load balancer",
- "length": 255,
- "name": "domainid",
- "related": "listDomainChildren,listDomains",
+ "description": "the description of the load balancer rule",
+ "length": 4096,
+ "name": "description",
"required": false,
- "type": "uuid"
- },
- {
- "description": "name of the load balancer rule",
- "length": 255,
- "name": "name",
- "required": true,
- "type": "string"
- },
- {
- "description": "domain name for the GSLB service.",
- "length": 255,
- "name": "gslbdomainname",
- "required": true,
"type": "string"
},
{
@@ -57360,11 +58105,12 @@
"type": "string"
},
{
- "description": "session sticky method (sourceip) if not specified defaults to sourceip",
+ "description": "the domain ID associated with the load balancer",
"length": 255,
- "name": "gslbstickysessionmethodname",
+ "name": "domainid",
+ "related": "listDomainChildren,listDomains",
"required": false,
- "type": "string"
+ "type": "uuid"
},
{
"description": "the account associated with the global load balancer. Must be used with the domainId parameter.",
@@ -57374,13 +58120,6 @@
"type": "string"
},
{
- "description": "the description of the load balancer rule",
- "length": 4096,
- "name": "description",
- "required": false,
- "type": "string"
- },
- {
"description": "region where the global load balancer is going to be created.",
"length": 255,
"name": "regionid",
@@ -57389,113 +58128,68 @@
"type": "integer"
},
{
+ "description": "name of the load balancer rule",
+ "length": 255,
+ "name": "name",
+ "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",
"required": false,
"type": "string"
+ },
+ {
+ "description": "domain name for the GSLB service.",
+ "length": 255,
+ "name": "gslbdomainname",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "session sticky method (sourceip) if not specified defaults to sourceip",
+ "length": 255,
+ "name": "gslbstickysessionmethodname",
+ "required": false,
+ "type": "string"
}
],
"related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule",
"response": [
{
- "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 project id of the load balancer",
- "name": "projectid",
- "type": "string"
- },
- {},
- {
- "description": "GSLB service type",
- "name": "gslbservicetype",
- "type": "string"
- },
- {
- "description": "name of the global load balancer rule",
- "name": "name",
- "type": "string"
- },
- {
- "description": "Load balancing method used for the global load balancer",
- "name": "gslblbmethod",
- "type": "string"
- },
- {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
{
+ "description": "Load balancing method used for the global load balancer",
+ "name": "gslblbmethod",
+ "type": "string"
+ },
+ {
+ "description": "the description of the global load balancer rule",
+ "name": "description",
+ "type": "string"
+ },
+ {
"description": "List of load balancer rules that are part of GSLB rule",
"name": "loadbalancerrule",
"response": [
{
- "description": "is rule for display to the regular user",
- "name": "fordisplay",
- "type": "boolean"
- },
- {
- "description": "the id of the guest network the lb rule belongs to",
- "name": "networkid",
+ "description": "the description of the load balancer",
+ "name": "description",
"type": "string"
},
{
- "description": "the state of the rule",
- "name": "state",
- "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 public ip address id",
- "name": "publicipid",
- "type": "string"
- },
- {
- "description": "the id of the zone the rule belongs to",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the domain of the load balancer rule",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the name of the zone the load balancer rule belongs to",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "the domain ID of the load balancer rule",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the name of the load balancer",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the project id of the load balancer",
- "name": "projectid",
+ "description": "the public port",
+ "name": "publicport",
"type": "string"
},
{
@@ -57504,6 +58198,11 @@
"type": "string"
},
{
+ "description": "the name of the zone the load balancer rule belongs to",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
"description": "the public ip address",
"name": "publicip",
"type": "string"
@@ -57514,42 +58213,17 @@
"type": "string"
},
{
- "description": "the private port",
- "name": "privateport",
- "type": "string"
- },
- {
"description": "the list of resource tags associated with load balancer",
"name": "tags",
"response": [
{
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
"description": "the project id the tag belongs to",
"name": "projectid",
"type": "string"
},
{
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
+ "description": "the project name where tag belongs to",
+ "name": "project",
"type": "string"
},
{
@@ -57571,18 +58245,38 @@
"description": "the ID of the domain associated with the tag",
"name": "domainid",
"type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
}
],
"type": "list"
},
{
- "description": "the public port",
- "name": "publicport",
+ "description": "the load balancer rule ID",
+ "name": "id",
"type": "string"
},
{
- "description": "the account of the load balancer rule",
- "name": "account",
+ "description": "the load balancer algorithm (source, roundrobin, leastconn)",
+ "name": "algorithm",
"type": "string"
},
{
@@ -57591,8 +58285,58 @@
"type": "string"
},
{
- "description": "the description of the load balancer",
- "name": "description",
+ "description": "the id of the zone the rule belongs to",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the state of the rule",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID of the load balancer rule",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the project id of the load balancer",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "is rule for display to the regular user",
+ "name": "fordisplay",
+ "type": "boolean"
+ },
+ {
+ "description": "the name of the load balancer",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the private port",
+ "name": "privateport",
+ "type": "string"
+ },
+ {
+ "description": "the public ip address id",
+ "name": "publicipid",
+ "type": "string"
+ },
+ {
+ "description": "the domain of the load balancer rule",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the id of the guest network the lb rule belongs to",
+ "name": "networkid",
+ "type": "string"
+ },
+ {
+ "description": "the account of the load balancer rule",
+ "name": "account",
"type": "string"
}
],
@@ -57604,18 +58348,13 @@
"type": "integer"
},
{
- "description": "the project name of the load balancer",
- "name": "project",
+ "description": "DNS domain name given for the global load balancer",
+ "name": "gslbdomainname",
"type": "string"
},
{
- "description": "Region Id in which global load balancer is created",
- "name": "regionid",
- "type": "integer"
- },
- {
- "description": "DNS domain name given for the global load balancer",
- "name": "gslbdomainname",
+ "description": "name of the global load balancer rule",
+ "name": "name",
"type": "string"
},
{
@@ -57624,11 +58363,22 @@
"type": "string"
},
{
- "description": "the description of the global load balancer rule",
- "name": "description",
+ "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": "GSLB service type",
+ "name": "gslbservicetype",
+ "type": "string"
+ },
+ {},
+ {
"description": "session persistence method used for the global load balancer",
"name": "gslbstickysessionmethodname",
"type": "string"
@@ -57638,6 +58388,16 @@
"name": "account",
"type": "string"
},
+ {
+ "description": "the project id of the load balancer",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the load balancer",
+ "name": "project",
+ "type": "string"
+ },
{}
]
},
@@ -57656,22 +58416,22 @@
}
],
"response": [
+ {},
{
"description": "any text associated with the success or failure",
"name": "displaytext",
"type": "string"
},
{
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
"description": "true if operation is executed successfully",
"name": "success",
"type": "boolean"
},
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {},
{},
{
"description": "the current status of the latest async job acting on this object",
@@ -57686,20 +58446,6 @@
"name": "listGlobalLoadBalancerRules",
"params": [
{
- "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
- "length": 255,
- "name": "isrecursive",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "List resources by tags (key/value pairs)",
- "length": 255,
- "name": "tags",
- "required": false,
- "type": "map"
- },
- {
"description": "the ID of the global load balancer rule",
"length": 255,
"name": "id",
@@ -57708,42 +58454,6 @@
"type": "uuid"
},
{
- "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false",
- "length": 255,
- "name": "listall",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "list resources by account. Must be used with the domainId parameter.",
- "length": 255,
- "name": "account",
- "required": false,
- "type": "string"
- },
- {
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
- },
- {
- "description": "",
- "length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
- },
- {
- "description": "list objects by project",
- "length": 255,
- "name": "projectid",
- "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject",
- "required": false,
- "type": "uuid"
- },
- {
"description": "region ID",
"length": 255,
"name": "regionid",
@@ -57752,6 +58462,41 @@
"type": "integer"
},
{
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false",
+ "length": 255,
+ "name": "listall",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "List resources by tags (key/value pairs)",
+ "length": 255,
+ "name": "tags",
+ "required": false,
+ "type": "map"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ },
+ {
"description": "list only resources belonging to the domain specified",
"length": 255,
"name": "domainid",
@@ -57760,37 +58505,42 @@
"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 resources by account. Must be used with the domainId parameter.",
+ "length": 255,
+ "name": "account",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "list objects by project",
+ "length": 255,
+ "name": "projectid",
+ "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject",
+ "required": false,
+ "type": "uuid"
}
],
"related": "updateGlobalLoadBalancerRule",
"response": [
{
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
"description": "List of load balancer rules that are part of GSLB rule",
"name": "loadbalancerrule",
"response": [
{
- "description": "the domain of the load balancer rule",
- "name": "domain",
- "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 zone the load balancer rule belongs to",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "the name of the load balancer",
- "name": "name",
+ "description": "the description of the load balancer",
+ "name": "description",
"type": "string"
},
{
@@ -57799,125 +58549,28 @@
"type": "string"
},
{
- "description": "the public ip address id",
- "name": "publicipid",
- "type": "string"
- },
- {
- "description": "the protocol of the loadbalanacer rule",
- "name": "protocol",
- "type": "string"
- },
- {
- "description": "the load balancer algorithm (source, roundrobin, leastconn)",
- "name": "algorithm",
- "type": "string"
- },
- {
- "description": "is rule for display to the regular user",
- "name": "fordisplay",
- "type": "boolean"
- },
- {
- "description": "the private port",
- "name": "privateport",
- "type": "string"
- },
- {
- "description": "the description of the load balancer",
- "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": "the list of resource tags associated with load balancer",
- "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": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- }
- ],
- "type": "list"
- },
- {
- "description": "the id of the zone the rule belongs to",
- "name": "zoneid",
- "type": "string"
- },
- {
"description": "the id of the guest network the lb rule belongs to",
"name": "networkid",
"type": "string"
},
{
+ "description": "the domain of the load balancer rule",
+ "name": "domain",
+ "type": "string"
+ },
+ {
"description": "the public ip address",
"name": "publicip",
"type": "string"
},
{
- "description": "the load balancer rule ID",
- "name": "id",
- "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"
},
{
@@ -57926,88 +58579,195 @@
"type": "string"
},
{
+ "description": "the private port",
+ "name": "privateport",
+ "type": "string"
+ },
+ {
+ "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).",
+ "name": "cidrlist",
+ "type": "string"
+ },
+ {
+ "description": "the public ip address id",
+ "name": "publicipid",
+ "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 list of resource tags associated with load balancer",
+ "name": "tags",
+ "response": [
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "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": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ }
+ ],
+ "type": "list"
+ },
+ {
+ "description": "the protocol of the loadbalanacer rule",
+ "name": "protocol",
+ "type": "string"
+ },
+ {
+ "description": "is rule for display to the regular user",
+ "name": "fordisplay",
+ "type": "boolean"
+ },
+ {
+ "description": "the domain ID of the load balancer rule",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
"description": "the state of the rule",
"name": "state",
"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 load balancer rule ID",
+ "name": "id",
+ "type": "string"
}
],
"type": "list"
},
{
- "description": "the domain ID of the load balancer rule",
- "name": "domainid",
+ "description": "the domain of the load balancer rule",
+ "name": "domain",
"type": "string"
},
{
- "description": "the description of the global load balancer rule",
- "name": "description",
- "type": "string"
- },
- {},
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "Load balancing method used for the global load balancer",
+ "name": "gslblbmethod",
"type": "string"
},
{
- "description": "Region Id in which global load balancer is created",
- "name": "regionid",
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
"type": "integer"
},
{
- "description": "GSLB service type",
- "name": "gslbservicetype",
- "type": "string"
- },
- {
- "description": "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",
- "name": "gslbstickysessionmethodname",
- "type": "string"
- },
- {
"description": "global load balancer rule ID",
"name": "id",
"type": "string"
},
{
+ "description": "the domain ID of the load balancer rule",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
"description": "the account of the load balancer rule",
"name": "account",
"type": "string"
},
+ {},
+ {
+ "description": "session persistence method used for the global load balancer",
+ "name": "gslbstickysessionmethodname",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "name of the global load balancer rule",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the description of the global load balancer rule",
+ "name": "description",
+ "type": "string"
+ },
{
"description": "the project name of the load balancer",
"name": "project",
"type": "string"
},
{
- "description": "DNS domain name given for the global load balancer",
- "name": "gslbdomainname",
+ "description": "GSLB service type",
+ "name": "gslbservicetype",
"type": "string"
},
{
- "description": "the domain of the load balancer rule",
- "name": "domain",
+ "description": "the project id of the load balancer",
+ "name": "projectid",
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
+ "description": "Region Id in which global load balancer is created",
+ "name": "regionid",
"type": "integer"
},
- {},
{
- "description": "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"
}
]
@@ -58032,22 +58792,22 @@
"name": "displaytext",
"type": "string"
},
+ {},
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
- {},
{
"description": "true if operation is executed successfully",
"name": "success",
"type": "boolean"
},
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
{}
]
},
@@ -58072,19 +58832,11 @@
"type": "uuid"
},
{
- "description": "list only resources belonging to the domain specified",
+ "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false",
"length": 255,
- "name": "domainid",
- "related": "listDomainChildren,listDomains",
+ "name": "listall",
"required": false,
- "type": "uuid"
- },
- {
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
+ "type": "boolean"
},
{
"description": "list by value",
@@ -58094,27 +58846,6 @@
"type": "string"
},
{
- "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",
- "length": 255,
- "name": "listall",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "list by customer name",
- "length": 255,
- "name": "customer",
- "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",
@@ -58122,20 +58853,6 @@
"type": "boolean"
},
{
- "description": "",
- "length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
- },
- {
- "description": "list by key",
- "length": 255,
- "name": "key",
- "required": false,
- "type": "string"
- },
- {
"description": "list by resource type",
"length": 255,
"name": "resourcetype",
@@ -58148,14 +58865,58 @@
"name": "page",
"required": false,
"type": "integer"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "list resources by account. Must be used with the domainId parameter.",
+ "length": 255,
+ "name": "account",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "list by key",
+ "length": 255,
+ "name": "key",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "list only resources belonging to the domain specified",
+ "length": 255,
+ "name": "domainid",
+ "related": "listDomainChildren,listDomains",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "list by customer name",
+ "length": 255,
+ "name": "customer",
+ "required": false,
+ "type": "string"
}
],
"related": "",
"response": [
+ {},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
},
{
"description": "customer associated with the tag",
@@ -58163,57 +58924,56 @@
"type": "string"
},
{
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
"description": "the project name where tag belongs to",
"name": "project",
"type": "string"
},
{
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
"description": "the 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",
+ "type": "string"
+ },
+ {
"description": "id of the resource",
"name": "resourceid",
"type": "string"
},
- {},
- {},
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
{
"description": "the account associated with the tag",
"name": "account",
"type": "string"
},
{
- "description": "resource type",
- "name": "resourcetype",
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
"type": "string"
- }
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "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"
+ },
+ {}
],
"since": "4.0.0"
},
@@ -58232,7 +58992,11 @@
}
],
"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",
@@ -58244,15 +59008,56 @@
"name": "jobstatus",
"type": "integer"
},
+ {},
{
"description": "true if operation is executed successfully",
"name": "success",
"type": "boolean"
+ }
+ ]
+ },
+ {
+ "description": "Get Kubernetes cluster config",
+ "isasync": false,
+ "name": "getKubernetesClusterConfig",
+ "params": [
+ {
+ "description": "the ID of the Kubernetes cluster",
+ "length": 255,
+ "name": "id",
+ "related": "createKubernetesCluster,startKubernetesCluster,upgradeKubernetesCluster",
+ "required": false,
+ "type": "uuid"
+ }
+ ],
+ "related": "",
+ "response": [
+ {},
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the id of the container cluster",
+ "name": "id",
+ "type": "string"
},
{
- "description": "any text associated with the success or failure",
- "name": "displaytext",
+ "description": "the config data of the cluster",
+ "name": "configdata",
"type": "string"
+ },
+ {
+ "description": "Name of the container cluster",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
}
]
},
@@ -58281,21 +59086,20 @@
"related": "configureVirtualRouterElement,listVirtualRouterElements",
"response": [
{
- "description": "the project id of the ipaddress",
- "name": "projectid",
- "type": "string"
- },
- {
"description": "Enabled/Disabled the service provider",
"name": "enabled",
"type": "boolean"
},
{
- "description": "the domain associated with the provider",
- "name": "domain",
+ "description": "the id of the router",
+ "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",
@@ -58312,26 +59116,27 @@
"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 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 account associated with the provider",
- "name": "account",
+ "description": "the project id of the ipaddress",
+ "name": "projectid",
"type": "string"
- }
+ },
+ {}
]
},
{
@@ -58340,13 +59145,6 @@
"name": "createVPC",
"params": [
{
- "description": "the cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR",
- "length": 255,
- "name": "cidr",
- "required": true,
- "type": "string"
- },
- {
"description": "the ID of the availability zone",
"length": 255,
"name": "zoneid",
@@ -58355,6 +59153,21 @@
"type": "uuid"
},
{
+ "description": "the account associated with the VPC. Must be used with the domainId parameter.",
+ "length": 255,
+ "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.",
+ "length": 255,
+ "name": "domainid",
+ "related": "listDomainChildren,listDomains",
+ "required": false,
+ "type": "uuid"
+ },
+ {
"description": "VPC network domain. All networks inside the VPC will belong to this domain",
"length": 255,
"name": "networkdomain",
@@ -58370,21 +59183,6 @@
"type": "boolean"
},
{
- "description": "the domain ID associated with the VPC. If used with the account parameter returns the VPC associated with the account for the specified domain.",
- "length": 255,
- "name": "domainid",
- "related": "listDomainChildren,listDomains",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "the account associated with the VPC. Must be used with the domainId parameter.",
- "length": 255,
- "name": "account",
- "required": false,
- "type": "string"
- },
- {
"description": "the display text of the VPC",
"length": 255,
"name": "displaytext",
@@ -58392,6 +59190,13 @@
"type": "string"
},
{
+ "description": "the name of the VPC",
+ "length": 255,
+ "name": "name",
+ "required": true,
+ "type": "string"
+ },
+ {
"description": "If set to false, the VPC won't start (VPC VR will not get allocated) until its first network gets implemented. True by default.",
"length": 255,
"name": "start",
@@ -58400,11 +59205,12 @@
"type": "boolean"
},
{
- "description": "the name of the VPC",
+ "description": "create VPC for the project",
"length": 255,
- "name": "name",
- "required": true,
- "type": "string"
+ "name": "projectid",
+ "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject",
+ "required": false,
+ "type": "uuid"
},
{
"description": "the ID of the VPC offering",
@@ -58415,29 +59221,39 @@
"type": "uuid"
},
{
- "description": "create VPC for the project",
+ "description": "the cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR",
"length": 255,
- "name": "projectid",
- "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject",
- "required": false,
- "type": "uuid"
+ "name": "cidr",
+ "required": true,
+ "type": "string"
}
],
"related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC",
"response": [
{
+ "description": "the domain id of the VPC owner",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
"description": "the date this VPC was created",
"name": "created",
"type": "date"
},
+ {},
{
- "description": "the list of networks belongign to the VPC",
- "name": "network",
- "type": "list"
+ "description": "the cidr the VPC",
+ "name": "cidr",
+ "type": "string"
},
{
- "description": "the id of the VPC",
- "name": "id",
+ "description": "the network domain of the VPC",
+ "name": "networkdomain",
+ "type": "string"
+ },
+ {
+ "description": "vpc offering name the VPC is created from",
+ "name": "vpcofferingname",
"type": "string"
},
{
@@ -58446,18 +59262,28 @@
"type": "string"
},
{
- "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",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "vpc offering id the VPC is created from",
+ "name": "vpcofferingid",
+ "type": "string"
+ },
+ {
+ "description": "true VPC requires restart",
+ "name": "restartrequired",
"type": "boolean"
},
{
- "description": "the cidr the VPC",
- "name": "cidr",
+ "description": "the id of the VPC",
+ "name": "id",
"type": "string"
},
{
@@ -58466,22 +59292,68 @@
"type": "boolean"
},
{
- "description": "true VPC requires restart",
- "name": "restartrequired",
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's",
+ "name": "distributedvpcrouter",
"type": "boolean"
},
{
+ "description": "the domain name of the owner",
+ "name": "domain",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "zone id of the vpc",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "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": "the owner of the VPC",
+ "name": "account",
+ "type": "string"
+ },
+ {
"description": "the list of resource tags associated with the project",
"name": "tags",
"response": [
{
+ "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 project id the tag belongs to",
"name": "projectid",
"type": "string"
},
{
- "description": "tag value",
- "name": "value",
+ "description": "the account associated with the tag",
+ "name": "account",
"type": "string"
},
{
@@ -58490,13 +59362,8 @@
"type": "string"
},
{
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
+ "description": "the domain associated with the tag",
+ "name": "domain",
"type": "string"
},
{
@@ -58510,77 +59377,36 @@
"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",
+ "description": "resource type",
+ "name": "resourcetype",
"type": "string"
}
],
"type": "list"
},
{
- "description": "the project id of the VPC",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "an alternate display text of the VPC.",
- "name": "displaytext",
- "type": "string"
- },
- {
"description": "true if VPC is region level",
"name": "regionlevelvpc",
"type": "boolean"
},
{
- "description": "the network domain of the VPC",
- "name": "networkdomain",
+ "description": "the list of networks belongign to the VPC",
+ "name": "network",
+ "type": "list"
+ },
+ {
+ "description": "the project name of the VPC",
+ "name": "project",
"type": "string"
},
{
- "description": "the name of the VPC",
- "name": "name",
- "type": "string"
- },
- {},
- {
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
+ "description": "if this VPC has redundant router",
+ "name": "redundantvpcrouter",
+ "type": "boolean"
},
{
- "description": "vpc offering name the VPC is created from",
- "name": "vpcofferingname",
- "type": "string"
- },
- {
- "description": "the domain name of the owner",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "zone id of the vpc",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "state of the VPC. Can be Inactive/Enabled",
- "name": "state",
+ "description": "an alternate display text of the VPC.",
+ "name": "displaytext",
"type": "string"
},
{
@@ -58588,53 +59414,6 @@
"name": "service",
"response": [
{
- "description": "the service provider name",
- "name": "provider",
- "response": [
- {
- "description": "the provider name",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the physical network this belongs to",
- "name": "physicalnetworkid",
- "type": "string"
- },
- {
- "description": "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": "uuid of the network provider",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the destination physical network",
- "name": "destinationphysicalnetworkid",
- "type": "string"
- }
- ],
- "type": "list"
- },
- {
- "description": "the service name",
- "name": "name",
- "type": "string"
- },
- {
"description": "the list of capabilities",
"name": "capability",
"response": [
@@ -58644,14 +59423,61 @@
"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"
+ },
+ {
+ "description": "the service provider name",
+ "name": "provider",
+ "response": [
+ {
+ "description": "the physical network this belongs to",
+ "name": "physicalnetworkid",
+ "type": "string"
},
{
- "description": "the capability name",
+ "description": "state of the network provider",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "true if individual services can be enabled/disabled",
+ "name": "canenableindividualservice",
+ "type": "boolean"
+ },
+ {
+ "description": "services for this provider",
+ "name": "servicelist",
+ "type": "list"
+ },
+ {
+ "description": "the provider name",
"name": "name",
"type": "string"
+ },
+ {
+ "description": "the destination physical network",
+ "name": "destinationphysicalnetworkid",
+ "type": "string"
+ },
+ {
+ "description": "uuid of the network provider",
+ "name": "id",
+ "type": "string"
}
],
"type": "list"
@@ -58660,34 +59486,13 @@
"type": "list"
},
{
- "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's",
- "name": "distributedvpcrouter",
- "type": "boolean"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
{
- "description": "the project name of the VPC",
- "name": "project",
- "type": "string"
- },
- {},
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "vpc offering id the VPC is created from",
- "name": "vpcofferingid",
- "type": "string"
- },
- {
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "the owner of the VPC",
- "name": "account",
+ "description": "the name of the VPC",
+ "name": "name",
"type": "string"
}
]
@@ -58708,26 +59513,26 @@
],
"response": [
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {},
- {},
- {
"description": "any text associated with the success or failure",
"name": "displaytext",
"type": "string"
},
{
- "description": "true if operation is executed successfully",
- "name": "success",
- "type": "boolean"
+ "description": "the current status of the latest async job acting 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"
}
]
},
@@ -58747,11 +59552,6 @@
],
"response": [
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
"description": "any text associated with the success or failure",
"name": "displaytext",
"type": "string"
@@ -58759,6 +59559,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"
@@ -58787,27 +59592,27 @@
],
"response": [
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "true if operation is executed successfully",
- "name": "success",
- "type": "boolean"
- },
- {
"description": "any text associated with the success or failure",
"name": "displaytext",
"type": "string"
},
+ {},
+ {
+ "description": "the UUID of the latest async job acting on 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"
+ }
]
},
{
@@ -58816,37 +59621,6 @@
"name": "listInternalLoadBalancerVMs",
"params": [
{
- "description": "list only resources belonging to the domain specified",
- "length": 255,
- "name": "domainid",
- "related": "listDomainChildren,listDomains",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
- },
- {
- "description": "list by network id",
- "length": 255,
- "name": "networkid",
- "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "list objects by project",
- "length": 255,
- "name": "projectid",
- "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject",
- "required": false,
- "type": "uuid"
- },
- {
"description": "list resources by account. Must be used with the domainId parameter.",
"length": 255,
"name": "account",
@@ -58854,14 +59628,6 @@
"type": "string"
},
{
- "description": "if true is passed for this parameter, also fetch last executed health check results for the VM. Default is false",
- "length": 255,
- "name": "fetchhealthcheckresults",
- "required": false,
- "since": "4.14",
- "type": "boolean"
- },
- {
"description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
"length": 255,
"name": "isrecursive",
@@ -58869,18 +59635,27 @@
"type": "boolean"
},
{
- "description": "if true is passed for this parameter, list only VPC Internal LB VMs",
+ "description": "the host ID of the Internal LB VM",
"length": 255,
- "name": "forvpc",
+ "name": "hostid",
+ "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost",
"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",
+ "description": "the state of the Internal LB VM",
"length": 255,
- "name": "listall",
+ "name": "state",
"required": false,
- "type": "boolean"
+ "type": "string"
+ },
+ {
+ "description": "list only resources belonging to the domain specified",
+ "length": 255,
+ "name": "domainid",
+ "related": "listDomainChildren,listDomains",
+ "required": false,
+ "type": "uuid"
},
{
"description": "the ID of the Internal LB VM",
@@ -58891,10 +59666,17 @@
"type": "uuid"
},
{
- "description": "List Internal LB VMs by VPC",
+ "description": "",
"length": 255,
- "name": "vpcid",
- "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC",
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "list objects by project",
+ "length": 255,
+ "name": "projectid",
+ "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject",
"required": false,
"type": "uuid"
},
@@ -58907,30 +59689,32 @@
"type": "uuid"
},
{
- "description": "",
+ "description": "list by network id",
"length": 255,
- "name": "page",
+ "name": "networkid",
+ "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks",
"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",
"length": 255,
- "name": "pagesize",
+ "name": "listall",
"required": false,
- "type": "integer"
+ "type": "boolean"
},
{
- "description": "the state of the Internal LB VM",
+ "description": "if true is passed for this parameter, also fetch last executed health check results for the VM. Default is false",
"length": 255,
- "name": "state",
+ "name": "fetchhealthcheckresults",
"required": false,
- "type": "string"
+ "since": "4.14",
+ "type": "boolean"
},
{
- "description": "the name of the Internal LB VM",
+ "description": "List by keyword",
"length": 255,
- "name": "name",
+ "name": "keyword",
"required": false,
"type": "string"
},
@@ -58943,269 +59727,66 @@
"type": "uuid"
},
{
- "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": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost",
+ "name": "forvpc",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "List Internal LB VMs by VPC",
+ "length": 255,
+ "name": "vpcid",
+ "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC",
"required": false,
"type": "uuid"
+ },
+ {
+ "description": "the name of the Internal LB VM",
+ "length": 255,
+ "name": "name",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
}
],
"related": "destroyRouter,listRouters",
"response": [
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the template ID for the router",
- "name": "templateid",
- "type": "string"
- },
- {
"description": "the guest IP address for the router",
"name": "guestipaddress",
"type": "string"
},
{
- "description": "the id of the router",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the state of the router",
- "name": "state",
- "type": "state"
- },
- {
- "description": "the ID of the corresponding link local network",
- "name": "linklocalnetworkid",
- "type": "string"
- },
- {
- "description": "the date and time the router was created",
- "name": "created",
- "type": "date"
- },
- {
- "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 second IPv6 DNS for the router",
- "name": "ip6dns2",
- "type": "string"
- },
- {
- "description": "the ID of the service offering of the virtual machine",
- "name": "serviceofferingid",
- "type": "string"
- },
- {
- "description": "the hypervisor on which the template runs",
- "name": "hypervisor",
- "type": "string"
- },
- {},
- {
- "description": "the public IP address for the router",
- "name": "publicip",
- "type": "string"
- },
- {
- "description": "the gateway for the router",
- "name": "gateway",
- "type": "string"
- },
- {
- "description": "the link local MAC address for the router",
- "name": "linklocalmacaddress",
- "type": "string"
- },
- {
- "description": "the network domain for the router",
- "name": "networkdomain",
- "type": "string"
- },
- {
- "description": "if this router is an redundant virtual router",
- "name": "isredundantrouter",
- "type": "boolean"
- },
- {
- "description": "the domain ID associated with the router",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "the domain associated with the router",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the account associated with the router",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the version of template",
- "name": "version",
- "type": "string"
- },
- {
- "description": "the version of scripts",
- "name": "scriptsversion",
- "type": "string"
- },
- {
- "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 public MAC address for the router",
- "name": "publicmacaddress",
- "type": "string"
- },
- {
- "description": "the state of redundant virtual router",
- "name": "redundantstate",
- "type": "string"
- },
- {
- "description": "the hostname for the router",
- "name": "hostname",
- "type": "string"
- },
- {
- "description": "the Zone ID for the router",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the Pod ID for the router",
- "name": "podid",
- "type": "string"
- },
- {
- "description": "the template name for the router",
- "name": "templatename",
- "type": "string"
- },
- {
- "description": "the project name of the address",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the name of the corresponding guest network",
- "name": "guestnetworkname",
- "type": "string"
- },
- {
- "description": "the Pod name for the router",
- "name": "podname",
- "type": "string"
- },
- {
- "description": "the second DNS for the router",
- "name": "dns2",
- "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 type of the health check - basic or advanced",
- "name": "checktype",
- "type": "string"
- },
- {
- "description": "the date this VPC was created",
- "name": "lastupdated",
- "type": "date"
- },
- {
- "description": "the 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": "role of the domain router",
- "name": "role",
- "type": "string"
- },
- {
- "description": "the name of the router",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the first DNS for the router",
- "name": "dns1",
- "type": "string"
- },
- {},
- {
- "description": "the ID of the corresponding guest network",
- "name": "guestnetworkid",
- "type": "string"
- },
- {
- "description": "the public netmask for the router",
- "name": "publicnetmask",
- "type": "string"
- },
- {
- "description": "the Zone name for the router",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "the project id of the ipaddress",
- "name": "projectid",
- "type": "string"
- },
- {
"description": "true if the router template requires upgrader",
"name": "requiresupgrade",
"type": "boolean"
},
{
- "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 network domain for the router",
+ "name": "networkdomain",
+ "type": "string"
+ },
+ {
+ "description": "the first IPv6 DNS for the router",
+ "name": "ip6dns1",
+ "type": "string"
+ },
+ {
+ "description": "the hostname for the router",
+ "name": "hostname",
+ "type": "string"
},
{
"description": "the guest netmask for the router",
@@ -59213,8 +59794,49 @@
"type": "string"
},
{
- "description": "the ID of the corresponding public network",
- "name": "publicnetworkid",
+ "description": "the hypervisor on which the template runs",
+ "name": "hypervisor",
+ "type": "string"
+ },
+ {
+ "description": "the public netmask for the router",
+ "name": "publicnetmask",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the name of the router",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the Pod name for the router",
+ "name": "podname",
+ "type": "string"
+ },
+ {
+ "description": "the template ID for the router",
+ "name": "templateid",
+ "type": "string"
+ },
+ {
+ "description": "the public MAC address for the router",
+ "name": "publicmacaddress",
+ "type": "string"
+ },
+ {
+ "description": "the Zone name for the router",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "the name of the service offering of the virtual machine",
+ "name": "serviceofferingname",
+ "type": "string"
+ },
+ {
+ "description": "the gateway for the router",
+ "name": "gateway",
"type": "string"
},
{
@@ -59222,28 +59844,8 @@
"name": "nic",
"response": [
{
- "description": "the ID of the nic",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the traffic type of the nic",
- "name": "traffictype",
- "type": "string"
- },
- {
- "description": "the IPv6 address of network",
- "name": "ip6address",
- "type": "string"
- },
- {
- "description": "the Secondary ipv4 addr of nic",
- "name": "secondaryip",
- "type": "list"
- },
- {
- "description": "ID of the VLAN/VNI if available",
- "name": "vlanid",
+ "description": "the isolated private VLAN if available",
+ "name": "isolatedpvlan",
"type": "integer"
},
{
@@ -59252,16 +59854,6 @@
"type": "string"
},
{
- "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise",
- "name": "nsxlogicalswitchport",
- "type": "string"
- },
- {
- "description": "Id of the vm to which the nic belongs",
- "name": "virtualmachineid",
- "type": "string"
- },
- {
"description": "the isolated private VLAN type if available",
"name": "isolatedpvlantype",
"type": "string"
@@ -59277,13 +59869,8 @@
"type": "string"
},
{
- "description": "the extra dhcp options on the nic",
- "name": "extradhcpoption",
- "type": "list"
- },
- {
- "description": "the cidr of IPv6 network",
- "name": "ip6cidr",
+ "description": "the type of the nic",
+ "name": "type",
"type": "string"
},
{
@@ -59292,18 +59879,43 @@
"type": "string"
},
{
- "description": "IP addresses associated with NIC found for unmanaged VM",
- "name": "ipaddresses",
- "type": "list"
- },
- {
"description": "the broadcast uri of the nic",
"name": "broadcasturi",
"type": "string"
},
{
- "description": "the ip address of the nic",
- "name": "ipaddress",
+ "description": "the cidr of IPv6 network",
+ "name": "ip6cidr",
+ "type": "string"
+ },
+ {
+ "description": "the traffic type of the nic",
+ "name": "traffictype",
+ "type": "string"
+ },
+ {
+ "description": "true if nic is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {
+ "description": "Id of the NSX Logical Switch (if NSX based), null otherwise",
+ "name": "nsxlogicalswitch",
+ "type": "string"
+ },
+ {
+ "description": "the IPv6 address of network",
+ "name": "ip6address",
+ "type": "string"
+ },
+ {
+ "description": "device id for the network when plugged into the virtual machine",
+ "name": "deviceid",
+ "type": "string"
+ },
+ {
+ "description": "Id of the vm to which the nic belongs",
+ "name": "virtualmachineid",
"type": "string"
},
{
@@ -59312,18 +59924,23 @@
"type": "string"
},
{
- "description": "the type of the nic",
- "name": "type",
+ "description": "the ID of the nic",
+ "name": "id",
"type": "string"
},
{
- "description": "Type of adapter if available",
- "name": "adaptertype",
- "type": "string"
+ "description": "IP addresses associated with NIC found for unmanaged VM",
+ "name": "ipaddresses",
+ "type": "list"
},
{
- "description": "the name of the corresponding network",
- "name": "networkname",
+ "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"
},
{
@@ -59332,41 +59949,77 @@
"type": "string"
},
{
- "description": "Id of the NSX Logical Switch (if NSX based), null otherwise",
- "name": "nsxlogicalswitch",
+ "description": "the name of the corresponding network",
+ "name": "networkname",
"type": "string"
},
{
- "description": "the isolated private VLAN if available",
- "name": "isolatedpvlan",
- "type": "integer"
- },
- {
- "description": "device id for the network when plugged into the virtual machine",
- "name": "deviceid",
+ "description": "Type of adapter if available",
+ "name": "adaptertype",
"type": "string"
},
{
- "description": "true if nic is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
+ "description": "the ip address of the nic",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "the Secondary ipv4 addr of nic",
+ "name": "secondaryip",
+ "type": "list"
+ },
+ {
+ "description": "the extra dhcp options on the nic",
+ "name": "extradhcpoption",
+ "type": "list"
}
],
"type": "set"
},
{
- "description": "the guest MAC address for the router",
- "name": "guestmacaddress",
+ "description": "the Zone ID for the router",
+ "name": "zoneid",
"type": "string"
},
{
- "description": "the link local IP address for the router",
- "name": "linklocalip",
+ "description": "the date and time the router was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
- "description": "the link local netmask for the router",
- "name": "linklocalnetmask",
+ "description": "the template name for the router",
+ "name": "templatename",
+ "type": "string"
+ },
+ {
+ "description": "VPC the router belongs to",
+ "name": "vpcid",
+ "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 name of VPC the router belongs to",
+ "name": "vpcname",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID associated with the router",
+ "name": "domainid",
"type": "string"
},
{
@@ -59375,8 +60028,160 @@
"type": "string"
},
{
- "description": "VPC the router belongs to",
- "name": "vpcid",
+ "description": "the id of the router",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "role of the domain router",
+ "name": "role",
+ "type": "string"
+ },
+ {
+ "description": "true if any health checks had failed",
+ "name": "healthchecksfailed",
+ "type": "boolean"
+ },
+ {
+ "description": "the ID of the corresponding guest network",
+ "name": "guestnetworkid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the service offering of the virtual machine",
+ "name": "serviceofferingid",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the address",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the name of the corresponding guest network",
+ "name": "guestnetworkname",
+ "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 version of scripts",
+ "name": "scriptsversion",
+ "type": "string"
+ },
+ {
+ "description": "the second DNS for the router",
+ "name": "dns2",
+ "type": "string"
+ },
+ {
+ "description": "the link local netmask for the router",
+ "name": "linklocalnetmask",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the corresponding public network",
+ "name": "publicnetworkid",
+ "type": "string"
+ },
+ {
+ "description": "the link local IP address for the router",
+ "name": "linklocalip",
+ "type": "string"
+ },
+ {
+ "description": "if this router is an redundant virtual router",
+ "name": "isredundantrouter",
+ "type": "boolean"
+ },
+ {
+ "description": "the first DNS for the router",
+ "name": "dns1",
+ "type": "string"
+ },
+ {
+ "description": "the link local MAC address for the router",
+ "name": "linklocalmacaddress",
+ "type": "string"
+ },
+ {
+ "description": "the second IPv6 DNS for the router",
+ "name": "ip6dns2",
+ "type": "string"
+ },
+ {
+ "description": "the Pod ID for the router",
+ "name": "podid",
+ "type": "string"
+ },
+ {
+ "description": "the state of the router",
+ "name": "state",
+ "type": "state"
+ },
+ {
+ "description": "the domain associated with the router",
+ "name": "domain",
+ "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": "the type of the health check - basic or advanced",
+ "name": "checktype",
+ "type": "string"
+ },
+ {
+ "description": "result of the health check",
+ "name": "success",
+ "type": "boolean"
+ },
+ {
+ "description": "the name of the health check on the router",
+ "name": "checkname",
+ "type": "string"
+ },
+ {
+ "description": "detailed response generated on running health check",
+ "name": "details",
+ "type": "string"
+ },
+ {
+ "description": "the date this VPC was created",
+ "name": "lastupdated",
+ "type": "date"
+ }
+ ],
+ "type": "list"
+ },
+ {
+ "description": "the ID of the corresponding link local network",
+ "name": "linklocalnetworkid",
+ "type": "string"
+ },
+ {
+ "description": "the version of template",
+ "name": "version",
"type": "string"
}
]
@@ -59387,13 +60192,6 @@
"name": "listCiscoVnmcResources",
"params": [
{
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
- },
- {
"description": "the Physical Network ID",
"length": 255,
"name": "physicalnetworkid",
@@ -59402,13 +60200,6 @@
"type": "uuid"
},
{
- "description": "",
- "length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
- },
- {
"description": "Cisco VNMC resource ID",
"length": 255,
"name": "resourceid",
@@ -59419,9 +60210,23 @@
{
"description": "",
"length": 255,
+ "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": "",
@@ -59431,18 +60236,18 @@
{},
{},
{},
- {},
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
{},
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- }
+ {}
]
},
{
@@ -59451,13 +60256,6 @@
"name": "removeResourceDetail",
"params": [
{
- "description": "Delete detail by resource type",
- "length": 255,
- "name": "resourcetype",
- "required": true,
- "type": "string"
- },
- {
"description": "Delete details for resource id",
"length": 255,
"name": "resourceid",
@@ -59470,6 +60268,13 @@
"name": "key",
"required": false,
"type": "string"
+ },
+ {
+ "description": "Delete detail by resource type",
+ "length": 255,
+ "name": "resourcetype",
+ "required": true,
+ "type": "string"
}
],
"response": [
@@ -59485,15 +60290,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": "true if operation is executed successfully",
+ "name": "success",
+ "type": "boolean"
}
]
},
@@ -59503,13 +60308,6 @@
"name": "listOsTypes",
"params": [
{
- "description": "",
- "length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
- },
- {
"description": "list os by description",
"length": 255,
"name": "description",
@@ -59518,20 +60316,6 @@
"type": "string"
},
{
- "description": "",
- "length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
- },
- {
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
- },
- {
"description": "list by Os type Id",
"length": 255,
"name": "id",
@@ -59540,17 +60324,42 @@
"type": "uuid"
},
{
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "list by Os Category id",
"length": 255,
"name": "oscategoryid",
"related": "listOsCategories",
"required": false,
"type": "uuid"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
}
],
"related": "addGuestOs",
"response": [
- {},
+ {
+ "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",
@@ -59567,20 +60376,16 @@
"name": "description",
"type": "string"
},
+ {},
{
- "description": "the ID of the OS type",
- "name": "id",
+ "description": "the ID of the OS category",
+ "name": "oscategoryid",
"type": "string"
},
{
"description": "is the guest OS user defined",
"name": "isuserdefined",
"type": "boolean"
- },
- {
- "description": "the ID of the OS category",
- "name": "oscategoryid",
- "type": "string"
}
]
},
@@ -59599,28 +60404,28 @@
}
],
"response": [
+ {},
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
{
- "description": "true if operation is executed successfully",
- "name": "success",
- "type": "boolean"
+ "description": "any text associated with the success or failure",
+ "name": "displaytext",
+ "type": "string"
},
- {},
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
+ {},
{
- "description": "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"
},
@@ -59645,6 +60450,13 @@
"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"
@@ -59653,14 +60465,7 @@
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
- },
- {},
- {
- "description": "any text associated with the success or failure",
- "name": "displaytext",
- "type": "string"
- },
- {}
+ }
],
"since": "4.4.0"
},
@@ -59670,16 +60475,16 @@
"name": "uploadResourceIcon",
"params": [
{
- "description": "Base64 string representation of the resource icon/image",
- "length": 2097152,
- "name": "base64image",
+ "description": "type of the resource",
+ "length": 255,
+ "name": "resourcetype",
"required": true,
"type": "string"
},
{
- "description": "type of the resource",
- "length": 255,
- "name": "resourcetype",
+ "description": "Base64 string representation of the resource icon/image",
+ "length": 2097152,
+ "name": "base64image",
"required": true,
"type": "string"
},
@@ -59692,11 +60497,7 @@
}
],
"response": [
- {
- "description": "true if operation is executed successfully",
- "name": "success",
- "type": "boolean"
- },
+ {},
{},
{
"description": "the current status of the latest async job acting on this object",
@@ -59704,11 +60505,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",
@@ -59723,13 +60528,6 @@
"name": "listSrxFirewallNetworks",
"params": [
{
- "description": "",
- "length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
- },
- {
"description": "List by keyword",
"length": 255,
"name": "keyword",
@@ -59750,28 +60548,288 @@
"related": "configureSrxFirewall",
"required": true,
"type": "uuid"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
}
],
"related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks",
"response": [
{
- "description": "the first DNS for the network",
- "name": "dns1",
+ "description": "VPC the network belongs to",
+ "name": "vpcid",
"type": "string"
},
{
+ "description": "The vlan of the network. This parameter is visible to ROOT admins only",
+ "name": "vlan",
+ "type": "string"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the traffic type of the network",
+ "name": "traffictype",
+ "type": "string"
+ },
+ {
+ "description": "list networks that are persistent",
+ "name": "ispersistent",
+ "type": "boolean"
+ },
+ {
+ "description": "the domain name of the network owner",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "true if network is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {
"description": "acl type - access type to the network",
"name": "acltype",
"type": "string"
},
{
- "description": "the project name of the address",
- "name": "project",
+ "description": "the network's gateway",
+ "name": "gateway",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the total number of network traffic bytes received",
+ "name": "receivedbytes",
+ "type": "long"
+ },
+ {
+ "description": "the date this network was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the network's netmask",
+ "name": "netmask",
"type": "string"
},
{
- "description": "VPC the network belongs to",
- "name": "vpcid",
+ "description": "the name of the zone the network belongs to",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans",
+ "name": "zonesnetworkspans",
+ "type": "set"
+ },
+ {
+ "description": "true network requires restart",
+ "name": "restartrequired",
+ "type": "boolean"
+ },
+ {
+ "description": "ACL Id associated with the VPC network",
+ "name": "aclid",
+ "type": "string"
+ },
+ {
+ "description": "related to what other network configuration",
+ "name": "related",
+ "type": "string"
+ },
+ {
+ "description": "the id of the network",
+ "name": "id",
+ "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": "broadcast uri of the network. This parameter is visible to ROOT admins only",
+ "name": "broadcasturi",
+ "type": "string"
+ },
+ {
+ "description": "the domain id of the network owner",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "Broadcast domain type of the network",
+ "name": "broadcastdomaintype",
+ "type": "string"
+ },
+ {
+ "description": "the network domain",
+ "name": "networkdomain",
+ "type": "string"
+ },
+ {
+ "description": "the name of the network",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the second DNS for the network",
+ "name": "dns2",
+ "type": "string"
+ },
+ {
+ "description": "ACL name associated with the VPC network",
+ "name": "aclname",
+ "type": "string"
+ },
+ {
+ "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR",
+ "name": "cidr",
+ "type": "string"
+ },
+ {
+ "description": "the displaytext of the network",
+ "name": "displaytext",
+ "type": "string"
+ },
+ {
+ "description": "Name of the VPC to which this network belongs",
+ "name": "vpcname",
+ "type": "string"
+ },
+ {
+ "description": "availability of the network offering the network is created from",
+ "name": "networkofferingavailability",
+ "type": "string"
+ },
+ {
+ "description": "the type of the network",
+ "name": "type",
+ "type": "string"
+ },
+ {
+ "description": "the first DNS for the network",
+ "name": "dns1",
+ "type": "string"
+ },
+ {
+ "description": "the total number of network traffic bytes sent",
+ "name": "sentbytes",
+ "type": "long"
+ },
+ {
+ "description": "the project id of the ipaddress",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "zone id of the network",
+ "name": "zoneid",
+ "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 cidr of IPv6 network",
+ "name": "ip6cidr",
+ "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 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": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ }
+ ],
+ "type": "list"
+ },
+ {
+ "description": "true if network supports specifying ip ranges, false otherwise",
+ "name": "specifyipranges",
+ "type": "boolean"
+ },
+ {
+ "description": "true if network can span multiple zones",
+ "name": "strechedl2subnet",
+ "type": "boolean"
+ },
+ {
+ "description": "the details of the network",
+ "name": "details",
+ "type": "map"
+ },
+ {
+ "description": "network offering id the network is created from",
+ "name": "networkofferingid",
"type": "string"
},
{
@@ -59780,8 +60838,23 @@
"type": "boolean"
},
{
- "description": "availability of the network offering the network is created from",
- "name": "networkofferingavailability",
+ "description": "the owner of the network",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "If the network has redundant routers enabled",
+ "name": "redundantrouter",
+ "type": "boolean"
+ },
+ {
+ "description": "the physical network id",
+ "name": "physicalnetworkid",
+ "type": "string"
+ },
+ {
+ "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes",
+ "name": "reservediprange",
"type": "string"
},
{
@@ -59789,23 +60862,23 @@
"name": "service",
"response": [
{
+ "description": "the service name",
+ "name": "name",
+ "type": "string"
+ },
+ {
"description": "the service provider name",
"name": "provider",
"response": [
{
- "description": "true if individual services can be enabled/disabled",
- "name": "canenableindividualservice",
- "type": "boolean"
- },
- {
"description": "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": "the physical network this belongs to",
@@ -59826,6 +60899,11 @@
"description": "services for this provider",
"name": "servicelist",
"type": "list"
+ },
+ {
+ "description": "the provider name",
+ "name": "name",
+ "type": "string"
}
],
"type": "list"
@@ -59835,6 +60913,11 @@
"name": "capability",
"response": [
{
+ "description": "can this service capability value can be choosable while creatine network offerings",
+ "name": "canchooseservicecapability",
+ "type": "boolean"
+ },
+ {
"description": "the capability name",
"name": "name",
"type": "string"
@@ -59843,81 +60926,16 @@
"description": "the capability value",
"name": "value",
"type": "string"
- },
- {
- "description": "can this service capability value can be choosable while creatine network offerings",
- "name": "canchooseservicecapability",
- "type": "boolean"
}
],
"type": "list"
- },
- {
- "description": "the service name",
- "name": "name",
- "type": "string"
}
],
"type": "list"
},
{
- "description": "If the network has redundant routers enabled",
- "name": "redundantrouter",
- "type": "boolean"
- },
- {
- "description": "related to what other network configuration",
- "name": "related",
- "type": "string"
- },
- {
- "description": "the domain name of the network owner",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the total number of network traffic bytes received",
- "name": "receivedbytes",
- "type": "long"
- },
- {
- "description": "state of the network",
- "name": "state",
- "type": "string"
- },
- {
- "description": "the details of the network",
- "name": "details",
- "type": "map"
- },
- {
- "description": "the name of the zone the network belongs to",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "the id of the network",
- "name": "id",
- "type": "string"
- },
- {
- "description": "display text of the network offering the network is created from",
- "name": "networkofferingdisplaytext",
- "type": "string"
- },
- {
- "description": "zone id of the network",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR",
- "name": "cidr",
- "type": "string"
- },
- {
- "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"
},
{
@@ -59926,141 +60944,94 @@
"type": "boolean"
},
{
- "description": "name of the network offering the network is created from",
- "name": "networkofferingname",
+ "description": "true if network offering is ip conserve mode enabled",
+ "name": "networkofferingconservemode",
+ "type": "boolean"
+ },
+ {
+ "description": "display text of the network offering the network is created from",
+ "name": "networkofferingdisplaytext",
"type": "string"
},
{
- "description": "Broadcast domain type of the network",
- "name": "broadcastdomaintype",
+ "description": "state of the network",
+ "name": "state",
"type": "string"
},
{
- "description": "the list of resource tags associated with network",
- "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": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "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": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- }
- ],
- "type": "list"
- },
- {
- "description": "the total number of network traffic bytes sent",
- "name": "sentbytes",
- "type": "long"
- },
- {},
- {
"description": "the gateway of IPv6 network",
"name": "ip6gateway",
"type": "string"
},
+ {},
{
- "description": "the project id of the ipaddress",
- "name": "projectid",
+ "description": "The external id of the network",
+ "name": "externalid",
"type": "string"
},
{
- "description": "list networks that are persistent",
- "name": "ispersistent",
+ "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": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes",
- "name": "reservediprange",
+ "description": "the project name of the address",
+ "name": "project",
"type": "string"
},
{
- "description": "true network requires restart",
- "name": "restartrequired",
- "type": "boolean"
- },
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ }
+ ]
+ },
+ {
+ "description": "Update a supported Kubernetes version",
+ "isasync": false,
+ "name": "updateKubernetesSupportedVersion",
+ "params": [
{
- "description": "the network domain",
- "name": "networkdomain",
+ "description": "the enabled or disabled state of the Kubernetes supported version",
+ "length": 255,
+ "name": "state",
+ "required": true,
"type": "string"
},
{
- "description": "Name of the VPC to which this network belongs",
- "name": "vpcname",
+ "description": "the ID of the Kubernetes supported version",
+ "length": 255,
+ "name": "id",
+ "related": "listKubernetesSupportedVersions,updateKubernetesSupportedVersion",
+ "required": true,
+ "type": "uuid"
+ }
+ ],
+ "related": "listKubernetesSupportedVersions",
+ "response": [
+ {
+ "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",
"type": "string"
},
{
- "description": "the owner of the network",
- "name": "account",
+ "description": "the id of the binaries ISO for Kubernetes supported version",
+ "name": "isoid",
"type": "string"
},
{
- "description": "the second DNS for the network",
- "name": "dns2",
- "type": "string"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
{
- "description": "ACL Id associated with the VPC network",
- "name": "aclid",
- "type": "string"
- },
- {
- "description": "ACL name associated with the VPC network",
- "name": "aclname",
- "type": "string"
- },
- {
- "description": "true if network can span multiple zones",
- "name": "strechedl2subnet",
+ "description": "whether Kubernetes supported version supports HA, multi-control nodes",
+ "name": "supportsha",
"type": "boolean"
},
{
@@ -60069,115 +61040,51 @@
"type": "string"
},
{
- "description": "true if network offering is ip conserve mode enabled",
- "name": "networkofferingconservemode",
- "type": "boolean"
- },
- {
- "description": "the displaytext of the network",
- "name": "displaytext",
+ "description": "the name of the zone in which Kubernetes supported version is available",
+ "name": "zonename",
"type": "string"
},
{
- "description": "the type of the network",
- "name": "type",
- "type": "string"
+ "description": "the minimum number of CPUs needed for the Kubernetes supported version",
+ "name": "mincpunumber",
+ "type": "integer"
},
{
- "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans",
- "name": "zonesnetworkspans",
- "type": "set"
- },
- {
- "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE",
- "name": "networkcidr",
- "type": "string"
- },
- {
- "description": "the traffic type of the network",
- "name": "traffictype",
- "type": "string"
- },
- {
- "description": "The vlan of the network. This parameter is visible to ROOT admins only",
- "name": "vlan",
- "type": "string"
- },
- {
- "description": "network offering id the network is created from",
- "name": "networkofferingid",
- "type": "string"
- },
- {
- "description": "the cidr of IPv6 network",
- "name": "ip6cidr",
- "type": "string"
- },
- {
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
- },
- {
- "description": "The external id of the network",
- "name": "externalid",
- "type": "string"
- },
- {
- "description": "true if network is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
- },
- {
- "description": "list networks available for vm deployment",
- "name": "canusefordeploy",
- "type": "boolean"
- },
- {
- "description": "the network's gateway",
- "name": "gateway",
- "type": "string"
- },
- {
- "description": "the domain id of the network owner",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the date this network was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the name of the network",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the network's netmask",
- "name": "netmask",
- "type": "string"
- },
- {
- "description": "the physical network id",
- "name": "physicalnetworkid",
+ "description": "the state of the binaries ISO for Kubernetes supported version",
+ "name": "isostate",
"type": "string"
},
{},
{
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
+ "description": "the name of the binaries ISO for Kubernetes supported version",
+ "name": "isoname",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "whether Kubernetes supported version supports Autoscaling",
+ "name": "supportsautoscaling",
"type": "boolean"
},
{
- "description": "true if network is system, false otherwise",
- "name": "issystem",
- "type": "boolean"
+ "description": "the id of the Kubernetes supported version",
+ "name": "id",
+ "type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "the id of the zone in which Kubernetes supported version is available",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "Kubernetes semantic version",
+ "name": "semanticversion",
+ "type": "string"
+ },
+ {
+ "description": "the enabled or disabled state of the Kubernetes supported version",
+ "name": "state",
+ "type": "string"
}
]
},
@@ -60206,8 +61113,40 @@
"related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance",
"response": [
{
- "description": "the name of the template for the virtual machine",
- "name": "templatename",
+ "description": "the date when this virtual machine was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the ID of the disk offering of the virtual machine",
+ "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",
+ "type": "string"
+ },
+ {},
+ {},
+ {
+ "description": "the total number of network traffic bytes sent",
+ "name": "sentbytes",
+ "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",
"type": "string"
},
{
@@ -60216,43 +61155,48 @@
"type": "boolean"
},
{
- "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": "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",
+ "description": "the outgoing network traffic on the host",
+ "name": "networkkbswrite",
"type": "long"
},
{
- "description": "the name of the service offering of the virtual machine",
- "name": "serviceofferingname",
+ "description": "device ID of the root volume",
+ "name": "rootdeviceid",
+ "type": "long"
+ },
+ {
+ "description": "an optional field whether to the display the vm to the end user or not.",
+ "name": "displayvm",
+ "type": "boolean"
+ },
+ {
+ "description": "Os type ID of the virtual machine",
+ "name": "guestosid",
"type": "string"
},
{
- "description": "the vgpu type used by the virtual machine",
- "name": "vgpu",
+ "description": "the read (bytes) of disk on the vm",
+ "name": "diskkbsread",
+ "type": "long"
+ },
+ {
+ "description": "the password (if exists) of the virtual machine",
+ "name": "password",
"type": "string"
},
{
- "description": "OS type id of the vm",
- "name": "ostypeid",
+ "description": "the target memory in vm",
+ "name": "memorytargetkbs",
+ "type": "long"
+ },
+ {
+ "description": "the group name of the virtual machine",
+ "name": "group",
"type": "string"
},
{
- "description": "the name of the availability zone for the virtual machine",
- "name": "zonename",
+ "description": "the name of the host for the virtual machine",
+ "name": "hostname",
"type": "string"
},
{
@@ -60261,403 +61205,59 @@
"type": "string"
},
{
- "description": "the incoming network traffic on the vm",
- "name": "networkkbsread",
+ "description": "the memory used by the vm",
+ "name": "memorykbs",
"type": "long"
},
{
- "description": "the account associated with the virtual machine",
- "name": "account",
+ "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": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the pool type of the virtual machine",
+ "name": "pooltype",
"type": "string"
},
{
- "description": "list of affinity groups associated with the virtual machine",
- "name": "affinitygroup",
- "response": [
- {
- "description": "the name of the affinity group",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the ID of the affinity group",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the type of the affinity group",
- "name": "type",
- "type": "string"
- },
- {
- "description": "the account owning the affinity group",
- "name": "account",
- "type": "string"
- },
- {
- "description": "virtual machine IDs associated with this affinity group",
- "name": "virtualmachineIds",
- "type": "list"
- },
- {
- "description": "the domain ID of the affinity group",
- "name": "domainid",
- "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 project ID of the affinity group",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the description of the affinity group",
- "name": "description",
- "type": "string"
- }
- ],
- "type": "set"
+ "description": "the speed of each cpu",
+ "name": "cpuspeed",
+ "type": "integer"
},
{
- "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 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 domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "the 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": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the account owning the security group",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the list of egress rules associated with the security group",
- "name": "egressrule",
- "response": [
- {
- "description": "the code for the ICMP message response",
- "name": "icmpcode",
- "type": "integer"
- },
- {
- "description": "account owning the security group rule",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the ending IP of the security group rule ",
- "name": "endport",
- "type": "integer"
- },
- {
- "description": "the starting IP of the security group rule",
- "name": "startport",
- "type": "integer"
- },
- {
- "description": "security group name",
- "name": "securitygroupname",
- "type": "string"
- },
- {
- "description": "the protocol of the security group rule",
- "name": "protocol",
- "type": "string"
- },
- {
- "description": "the type of the ICMP message response",
- "name": "icmptype",
- "type": "integer"
- },
- {
- "description": "the list of resource tags associated with the rule",
- "name": "tags",
- "response": [
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "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": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the CIDR notation for the base IP address of the security group rule",
- "name": "cidr",
- "type": "string"
- },
- {
- "description": "the id of the security group rule",
- "name": "ruleid",
- "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 starting IP of the security group rule",
- "name": "startport",
- "type": "integer"
- },
- {
- "description": "the ending IP of the security group rule ",
- "name": "endport",
- "type": "integer"
- },
- {
- "description": "security group name",
- "name": "securitygroupname",
- "type": "string"
- },
- {
- "description": "the CIDR notation for the base IP address of the security group rule",
- "name": "cidr",
- "type": "string"
- },
- {
- "description": "the protocol of the security group rule",
- "name": "protocol",
- "type": "string"
- },
- {
- "description": "the list of resource tags associated with the rule",
- "name": "tags",
- "response": [
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "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": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the code for the ICMP message response",
- "name": "icmpcode",
- "type": "integer"
- },
- {
- "description": "the type of the ICMP message response",
- "name": "icmptype",
- "type": "integer"
- },
- {
- "description": "the id of the security group rule",
- "name": "ruleid",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the 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 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 project id of the group",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the name of the security group",
- "name": "name",
- "type": "string"
- }
- ],
- "type": "set"
+ "description": "the total number of network traffic bytes received",
+ "name": "receivedbytes",
+ "type": "long"
+ },
+ {
+ "description": "the ID of the domain in which the virtual machine exists",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "OS type id of the vm",
+ "name": "ostypeid",
+ "type": "string"
+ },
+ {
+ "description": "public IP address id associated with vm via Static nat rule",
+ "name": "publicip",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the availablility zone for the virtual machine",
+ "name": "zoneid",
+ "type": "string"
},
{
"description": "State of the Service from LB rule",
@@ -60665,57 +61265,228 @@
"type": "string"
},
{
- "description": "the list of resource tags associated",
- "name": "tags",
+ "description": "the date when this virtual machine was updated last time",
+ "name": "lastupdated",
+ "type": "date"
+ },
+ {
+ "description": "Guest vm Boot Type",
+ "name": "boottype",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the vm",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the user's name who deployed the virtual machine",
+ "name": "username",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": " an alternate display text of the template for the virtual machine",
+ "name": "templatedisplaytext",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the host for the virtual machine",
+ "name": "hostid",
+ "type": "string"
+ },
+ {
+ "description": "the memory allocated for the virtual machine",
+ "name": "memory",
+ "type": "integer"
+ },
+ {
+ "description": "the name of the virtual machine",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the internal memory that's free in vm or zero if it can not be calculated",
+ "name": "memoryintfreekbs",
+ "type": "long"
+ },
+ {
+ "description": "the write (io) of disk on the vm",
+ "name": "diskiowrite",
+ "type": "long"
+ },
+ {
+ "description": "the name of the disk offering of the virtual machine",
+ "name": "diskofferingname",
+ "type": "string"
+ },
+ {
+ "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",
+ "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": "the ID of the service offering of the virtual machine",
+ "name": "serviceofferingid",
+ "type": "string"
+ },
+ {
+ "description": "the write (bytes) of disk on the vm",
+ "name": "diskkbswrite",
+ "type": "long"
+ },
+ {
+ "description": "the list of nics associated with vm",
+ "name": "nic",
"response": [
{
- "description": "the account associated with the tag",
- "name": "account",
+ "description": "the gateway of IPv6 network",
+ "name": "ip6gateway",
"type": "string"
},
{
- "description": "the domain associated with the tag",
- "name": "domain",
+ "description": "true if nic is default, false otherwise",
+ "name": "macaddress",
"type": "string"
},
{
- "description": "tag value",
- "name": "value",
+ "description": "the ID of the nic",
+ "name": "id",
"type": "string"
},
{
- "description": "the project id the tag belongs to",
- "name": "projectid",
+ "description": "the traffic type of the nic",
+ "name": "traffictype",
"type": "string"
},
{
- "description": "the project name where tag belongs to",
- "name": "project",
+ "description": "Type of adapter if available",
+ "name": "adaptertype",
"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": "id of the resource",
- "name": "resourceid",
+ "description": "Id of the NSX Logical Switch (if NSX based), null otherwise",
+ "name": "nsxlogicalswitch",
"type": "string"
},
{
- "description": "tag key name",
- "name": "key",
+ "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": "customer associated with the tag",
- "name": "customer",
+ "description": "the isolated private VLAN if available",
+ "name": "isolatedpvlan",
+ "type": "integer"
+ },
+ {
+ "description": "true if nic is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {
+ "description": "ID of the VLAN/VNI if available",
+ "name": "vlanid",
+ "type": "integer"
+ },
+ {
+ "description": "the IPv6 address of network",
+ "name": "ip6address",
"type": "string"
},
{
- "description": "resource type",
- "name": "resourcetype",
+ "description": "Id of the vm to which the nic belongs",
+ "name": "virtualmachineid",
+ "type": "string"
+ },
+ {
+ "description": "the netmask of the nic",
+ "name": "netmask",
+ "type": "string"
+ },
+ {
+ "description": "the broadcast uri of the nic",
+ "name": "broadcasturi",
+ "type": "string"
+ },
+ {
+ "description": "the Secondary ipv4 addr of nic",
+ "name": "secondaryip",
+ "type": "list"
+ },
+ {
+ "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise",
+ "name": "nsxlogicalswitchport",
+ "type": "string"
+ },
+ {
+ "description": "the cidr of IPv6 network",
+ "name": "ip6cidr",
+ "type": "string"
+ },
+ {
+ "description": "the type of the nic",
+ "name": "type",
+ "type": "string"
+ },
+ {
+ "description": "the name of the corresponding network",
+ "name": "networkname",
+ "type": "string"
+ },
+ {
+ "description": "the ip address of the nic",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "the extra dhcp options on the nic",
+ "name": "extradhcpoption",
+ "type": "list"
+ },
+ {
+ "description": "device id for the network when plugged into the virtual machine",
+ "name": "deviceid",
+ "type": "string"
+ },
+ {
+ "description": "the isolation uri of the nic",
+ "name": "isolationuri",
+ "type": "string"
+ },
+ {
+ "description": "the isolated private VLAN type if available",
+ "name": "isolatedpvlantype",
"type": "string"
}
],
@@ -60727,423 +61498,33 @@
"type": "integer"
},
{
- "description": "the name of the virtual machine",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the project name of the vm",
- "name": "project",
- "type": "string"
- },
- {
"description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.",
"name": "templateid",
"type": "string"
},
{
- "description": "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 target memory in vm",
- "name": "memorytargetkbs",
- "type": "long"
- },
- {
- "description": "device type of the root volume",
- "name": "rootdevicetype",
- "type": "string"
- },
- {
- "description": "the ID of the disk offering of the virtual machine",
- "name": "diskofferingid",
- "type": "string"
- },
- {
- "description": "the ID of the availablility zone for the virtual machine",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the password (if exists) of the virtual machine",
- "name": "password",
- "type": "string"
- },
- {
- "description": "the outgoing network traffic on the host",
- "name": "networkkbswrite",
- "type": "long"
- },
- {
- "description": "the name of the disk offering of the virtual machine",
- "name": "diskofferingname",
- "type": "string"
- },
- {
- "description": "OS name of the vm",
- "name": "osdisplayname",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "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": "Guest vm Boot Mode",
- "name": "bootmode",
- "type": "string"
- },
- {
- "description": "the pool type of the virtual machine",
- "name": "pooltype",
- "type": "string"
- },
- {
"description": "the hypervisor on which the template runs",
"name": "hypervisor",
"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": "user generated name. The name of the virtual machine is returned if no displayname exists.",
- "name": "displayname",
- "type": "string"
- },
- {
- "description": "the internal memory that's free in vm or zero if it can not be calculated",
- "name": "memoryintfreekbs",
- "type": "long"
- },
- {
- "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 list of nics associated with vm",
- "name": "nic",
- "response": [
- {
- "description": "the name of the corresponding network",
- "name": "networkname",
- "type": "string"
- },
- {
- "description": "the isolation uri of the nic",
- "name": "isolationuri",
- "type": "string"
- },
- {
- "description": "the traffic type of the nic",
- "name": "traffictype",
- "type": "string"
- },
- {
- "description": "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 NSX Logical Switch (if NSX based), null otherwise",
- "name": "nsxlogicalswitch",
- "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 extra dhcp options on the nic",
- "name": "extradhcpoption",
- "type": "list"
- },
- {
- "description": "the netmask of the nic",
- "name": "netmask",
- "type": "string"
- },
- {
- "description": "the ID of the corresponding network",
- "name": "networkid",
- "type": "string"
- },
- {
- "description": "the ip address of the nic",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "description": "the gateway of IPv6 network",
- "name": "ip6gateway",
- "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": "the ID of the nic",
- "name": "id",
- "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": "true if nic is default, false otherwise",
- "name": "macaddress",
- "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": "the type of the nic",
- "name": "type",
- "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",
- "type": "string"
- },
- {
- "description": "the IPv6 address of network",
- "name": "ip6address",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the total number of network traffic bytes sent",
- "name": "sentbytes",
- "type": "long"
- },
- {
- "description": "true if high-availability is enabled, false otherwise",
- "name": "haenable",
- "type": "boolean"
- },
- {
- "description": "the name of the host for the virtual machine",
- "name": "hostname",
- "type": "string"
- },
- {
- "description": "the read (io) of disk on the vm",
- "name": "diskioread",
- "type": "long"
- },
- {
"description": "ssh key-pair",
"name": "keypair",
"type": "string"
},
{
- "description": "Guest vm Boot Type",
- "name": "boottype",
- "type": "string"
- },
- {
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
- },
- {
- "description": "the name of the domain in which the virtual machine exists",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "Vm details in key/value pairs.",
- "name": "details",
- "type": "map"
- },
- {
- "description": "List of read-only Vm details as comma separated string.",
- "name": "readonlydetails",
- "type": "string"
- },
- {
- "description": "the user's ID who deployed the virtual machine",
- "name": "userid",
- "type": "string"
- },
- {
- "description": "the user's name who deployed the virtual machine",
- "name": "username",
- "type": "string"
- },
- {
- "description": "the ID of the domain in which the virtual machine exists",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": " an alternate display text of the template for the virtual machine",
- "name": "templatedisplaytext",
- "type": "string"
- },
- {
- "description": "the name of the backup offering of the virtual machine",
- "name": "backupofferingname",
- "type": "string"
- },
- {
- "description": "the name of the ISO attached to the virtual machine",
- "name": "isoname",
- "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": "the read (bytes) of disk on the vm",
- "name": "diskkbsread",
- "type": "long"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the ID of the virtual machine",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the speed of each cpu",
- "name": "cpuspeed",
- "type": "integer"
- },
- {
- "description": "the date when this virtual machine was updated last time",
- "name": "lastupdated",
- "type": "date"
- },
- {
- "description": "the memory allocated for the virtual machine",
- "name": "memory",
- "type": "integer"
- },
- {
"description": "the project id of the vm",
"name": "projectid",
"type": "string"
},
{
- "description": "the memory used by the vm",
- "name": "memorykbs",
- "type": "long"
- },
- {
- "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 virtual network for the service offering",
- "name": "forvirtualnetwork",
- "type": "boolean"
- },
- {
- "description": "the write (bytes) of disk on the vm",
- "name": "diskkbswrite",
- "type": "long"
- },
- {
- "description": "an alternate display text of the ISO attached to the virtual machine",
- "name": "isodisplaytext",
- "type": "string"
- },
- {
- "description": "the group ID of the virtual machine",
- "name": "groupid",
+ "description": "the ID of the virtual machine",
+ "name": "id",
"type": "string"
},
{
@@ -61152,9 +61533,535 @@
"type": "string"
},
{
- "description": "Os type ID of the virtual machine",
- "name": "guestosid",
+ "description": "the incoming network traffic on the vm",
+ "name": "networkkbsread",
+ "type": "long"
+ },
+ {
+ "description": "Guest vm Boot Mode",
+ "name": "bootmode",
"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": "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": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "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",
+ "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 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": "user generated name. The name of the virtual machine is returned if no displayname exists.",
+ "name": "displayname",
+ "type": "string"
+ },
+ {
+ "description": "the user's ID who deployed the virtual machine",
+ "name": "userid",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the group ID of the virtual machine",
+ "name": "groupid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the template for the virtual machine",
+ "name": "templatename",
+ "type": "string"
+ },
+ {
+ "description": "the read (io) of disk on the vm",
+ "name": "diskioread",
+ "type": "long"
+ },
+ {
+ "description": "the name of the domain in which the virtual machine exists",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "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",
+ "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 domain ID of the affinity group",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the affinity group",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the affinity group",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the name of the affinity group",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the account owning the affinity group",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the type of the affinity group",
+ "name": "type",
+ "type": "string"
+ },
+ {
+ "description": "the description of the affinity group",
+ "name": "description",
+ "type": "string"
+ },
+ {
+ "description": "the project ID of the affinity group",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "virtual machine IDs associated with this affinity group",
+ "name": "virtualmachineIds",
+ "type": "list"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "list of security groups associated with the virtual machine",
+ "name": "securitygroup",
+ "response": [
+ {
+ "description": "the project name of the group",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the account owning the security group",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the domain name of the security group",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the security group",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the description of the security group",
+ "name": "description",
+ "type": "string"
+ },
+ {
+ "description": "the list of resource tags associated with the rule",
+ "name": "tags",
+ "response": [
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "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 domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the domain ID of the security group",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the project id of the group",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the list of virtualmachine ids associated with this securitygroup",
+ "name": "virtualmachineids",
+ "type": "set"
+ },
+ {
+ "description": "the list of egress rules associated with the security group",
+ "name": "egressrule",
+ "response": [
+ {
+ "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": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "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 domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the CIDR notation for the base IP address of the security group rule",
+ "name": "cidr",
+ "type": "string"
+ },
+ {
+ "description": "the ending IP of the security group rule ",
+ "name": "endport",
+ "type": "integer"
+ },
+ {
+ "description": "the id of the security group rule",
+ "name": "ruleid",
+ "type": "string"
+ },
+ {
+ "description": "the starting IP of the security group rule",
+ "name": "startport",
+ "type": "integer"
+ },
+ {
+ "description": "account owning the security group rule",
+ "name": "account",
+ "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": "security group name",
+ "name": "securitygroupname",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the name of the security group",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the list of ingress rules associated with the security group",
+ "name": "ingressrule",
+ "response": [
+ {
+ "description": "the starting IP of the security group rule",
+ "name": "startport",
+ "type": "integer"
+ },
+ {
+ "description": "the id of the security group rule",
+ "name": "ruleid",
+ "type": "string"
+ },
+ {
+ "description": "security group name",
+ "name": "securitygroupname",
+ "type": "string"
+ },
+ {
+ "description": "account owning the security group rule",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the 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": "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 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": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the type of the ICMP message response",
+ "name": "icmptype",
+ "type": "integer"
+ },
+ {
+ "description": "the 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"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the number of virtualmachines associated with this securitygroup",
+ "name": "virtualmachinecount",
+ "type": "integer"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
}
]
},
@@ -61173,13 +62080,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",
"type": "boolean"
@@ -61189,11 +62100,7 @@
"name": "jobid",
"type": "string"
},
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
+ {},
{}
]
},
@@ -61213,6 +62120,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"
@@ -61220,19 +62132,14 @@
{},
{},
{
- "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"
}
]
},
@@ -61265,13 +62172,13 @@
],
"related": "",
"response": [
- {},
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
{},
+ {},
{
"description": "Deployment Planner name",
"name": "name",
@@ -61299,17 +62206,10 @@
}
],
"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",
@@ -61317,10 +62217,17 @@
"type": "string"
},
{
- "description": "true if operation is executed successfully",
- "name": "success",
- "type": "boolean"
- }
+ "description": "any text associated with the success or failure",
+ "name": "displaytext",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {}
]
},
{
@@ -61340,354 +62247,164 @@
"related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost",
"response": [
{
- "description": "the management server ID of the host",
- "name": "managementserverid",
- "type": "string"
- },
- {
- "description": "the Zone ID of the host",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the incoming network traffic on the host",
- "name": "networkkbsread",
- "type": "long"
- },
- {
- "description": "the Pod ID of the host",
- "name": "podid",
- "type": "string"
- },
- {
- "description": "the OS category ID of the host",
- "name": "oscategoryid",
- "type": "string"
- },
- {
- "description": "the host hypervisor",
- "name": "hypervisor",
- "type": "hypervisortype"
- },
- {
- "description": "the total disk size of the host",
- "name": "disksizetotal",
- "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": "Model Name of vGPU",
- "name": "vgputype",
- "type": "string"
- },
- {
- "description": "Maximum no. of vgpu per gpu card (pgpu)",
- "name": "maxvgpuperpgpu",
- "type": "long"
- },
- {
- "description": "Video RAM for this vGPU type",
- "name": "videoram",
- "type": "long"
- },
- {
- "description": "Maximum Y resolution per display",
- "name": "maxresolutiony",
- "type": "long"
- },
- {
- "description": "Maximum vgpu can be created with this vgpu type on the given gpu group",
- "name": "maxcapacity",
- "type": "long"
- },
- {
- "description": "Maximum displays per user",
- "name": "maxheads",
- "type": "long"
- },
- {
- "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"
- }
- ],
- "type": "list"
- }
- ],
- "type": "list"
- },
- {},
- {
- "description": "the amount of the host's CPU currently used",
- "name": "cpuused",
- "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": "true if local storage is active, false otherwise",
- "name": "islocalstorageactive",
- "type": "boolean"
- },
- {
- "description": "the host out-of-band management information",
- "name": "outofbandmanagement",
- "type": "outofbandmanagementresponse"
- },
- {
- "description": "the last time this host was annotated",
- "name": "lastannotated",
- "type": "date"
- },
- {
- "description": "the ID of the host",
- "name": "id",
- "type": "string"
- },
- {
- "description": "comma-separated list of tags for the host",
- "name": "hosttags",
- "type": "string"
- },
- {
- "description": "the date and time the host was removed",
- "name": "removed",
- "type": "date"
- },
- {
- "description": "the amount of the host's CPU currently allocated in MHz",
- "name": "cpuallocatedvalue",
- "type": "long"
- },
- {
- "description": "the outgoing network traffic on the host",
- "name": "networkkbswrite",
- "type": "long"
- },
- {
- "description": "the CPU speed of the host",
- "name": "cpuspeed",
- "type": "long"
- },
- {
- "description": "the IP address of the host",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "description": "the amount of the host's memory after applying the mem.overprovisioning.factor",
- "name": "memorywithoverprovisioning",
- "type": "string"
- },
- {
"description": "the name of the host",
"name": "name",
"type": "string"
},
{
- "description": "the host type",
- "name": "type",
- "type": "type"
- },
- {
- "description": "the amount of the host's memory currently allocated in percentage",
- "name": "memoryallocatedpercentage",
- "type": "string"
- },
- {
- "description": "Host details in key/value pairs.",
- "name": "details",
- "type": "map"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the resource state of the host",
- "name": "resourcestate",
- "type": "string"
- },
- {
- "description": "the CPU number of the host",
- "name": "cpunumber",
- "type": "integer"
- },
- {
- "description": "the admin that annotated this host",
- "name": "username",
- "type": "string"
- },
- {
- "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise",
- "name": "hahost",
- "type": "boolean"
- },
- {
- "description": "capabilities of the host",
- "name": "capabilities",
- "type": "string"
- },
- {
- "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor",
- "name": "cpuwithoverprovisioning",
- "type": "string"
- },
- {
- "description": "the cluster ID of the host",
- "name": "clusterid",
- "type": "string"
- },
- {
"description": "the last annotation set on this host by an admin",
"name": "annotation",
"type": "string"
},
{
+ "description": "the amount of the host's memory currently used",
+ "name": "memoryused",
+ "type": "long"
+ },
+ {
+ "description": "the cluster name of the host",
+ "name": "clustername",
+ "type": "string"
+ },
+ {
+ "description": "true if the host has capability to support UEFI boot",
+ "name": "ueficapability",
+ "type": "boolean"
+ },
+ {},
+ {
+ "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning",
+ "name": "memorytotal",
+ "type": "long"
+ },
+ {
+ "description": "the host version",
+ "name": "version",
+ "type": "string"
+ },
+ {
+ "description": "the host hypervisor",
+ "name": "hypervisor",
+ "type": "hypervisortype"
+ },
+ {
+ "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": "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": "Maximum vgpu can be created with this vgpu type on the given gpu group",
+ "name": "maxcapacity",
+ "type": "long"
+ },
+ {
+ "description": "Maximum Y resolution per display",
+ "name": "maxresolutiony",
+ "type": "long"
+ },
+ {
+ "description": "Model Name of vGPU",
+ "name": "vgputype",
+ "type": "string"
+ },
+ {
+ "description": "Maximum X resolution per display",
+ "name": "maxresolutionx",
+ "type": "long"
+ },
+ {
+ "description": "Video RAM for this vGPU type",
+ "name": "videoram",
+ "type": "long"
+ },
+ {
+ "description": "Maximum displays per user",
+ "name": "maxheads",
+ "type": "long"
+ }
+ ],
+ "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": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise",
"name": "suitableformigration",
"type": "boolean"
},
{
- "description": "the amount of the host's memory currently allocated",
- "name": "memoryallocated",
- "type": "long"
- },
- {
"description": "events available for the host",
"name": "events",
"type": "string"
},
{
+ "description": "the management server ID of the host",
+ "name": "managementserverid",
+ "type": "string"
+ },
+ {
+ "description": "the OS category ID of the host",
+ "name": "oscategoryid",
+ "type": "string"
+ },
+ {
"description": "the amount of the host's memory currently allocated in bytes",
"name": "memoryallocatedbytes",
"type": "long"
},
{
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
+ "description": "the last time this host was annotated",
+ "name": "lastannotated",
+ "type": "date"
},
{
- "description": "the state of the host",
- "name": "state",
- "type": "status"
- },
- {
- "description": "the Zone name of the host",
- "name": "zonename",
- "type": "string"
- },
- {
- "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 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 CPU currently allocated",
- "name": "cpuallocated",
- "type": "string"
- },
- {
- "description": "true if the host is disconnected. False otherwise.",
- "name": "disconnected",
+ "description": "the date and time the host was removed",
+ "name": "removed",
"type": "date"
},
{
- "description": "the host version",
- "name": "version",
- "type": "string"
- },
- {
- "description": "the cluster type of the cluster that host belongs to",
- "name": "clustertype",
- "type": "string"
- },
- {
- "description": "the Pod name of the host",
- "name": "podname",
- "type": "string"
- },
- {
- "description": "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 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": "true if the host has capability to support UEFI boot",
- "name": "ueficapability",
- "type": "boolean"
- },
- {
- "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's currently allocated disk size",
- "name": "disksizeallocated",
+ "description": "the amount of the host's memory currently allocated",
+ "name": "memoryallocated",
"type": "long"
},
{
@@ -61696,9 +62413,199 @@
"type": "string"
},
{
- "description": "the amount of the host's memory currently used",
- "name": "memoryused",
+ "description": "the Zone name of the host",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "the CPU speed of the host",
+ "name": "cpuspeed",
"type": "long"
+ },
+ {
+ "description": "the incoming network traffic on the host",
+ "name": "networkkbsread",
+ "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 UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "capabilities of the host",
+ "name": "capabilities",
+ "type": "string"
+ },
+ {
+ "description": "the host type",
+ "name": "type",
+ "type": "type"
+ },
+ {
+ "description": "true if local storage is active, false otherwise",
+ "name": "islocalstorageactive",
+ "type": "boolean"
+ },
+ {
+ "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise",
+ "name": "hahost",
+ "type": "boolean"
+ },
+ {
+ "description": "the amount of the host's CPU currently allocated in percentage",
+ "name": "cpuallocatedpercentage",
+ "type": "string"
+ },
+ {
+ "description": "Host details in key/value pairs.",
+ "name": "details",
+ "type": "map"
+ },
+ {
+ "description": "comma-separated list of tags for the host",
+ "name": "hosttags",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the host's memory currently allocated in percentage",
+ "name": "memoryallocatedpercentage",
+ "type": "string"
+ },
+ {
+ "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 outgoing network traffic on the host",
+ "name": "networkkbswrite",
+ "type": "long"
+ },
+ {
+ "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 admin that annotated this host",
+ "name": "username",
+ "type": "string"
+ },
+ {
+ "description": "the cluster ID of the host",
+ "name": "clusterid",
+ "type": "string"
+ },
+ {
+ "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 CPU after applying the cpu.overprovisioning.factor",
+ "name": "cpuwithoverprovisioning",
+ "type": "string"
+ },
+ {
+ "description": "the hypervisor version",
+ "name": "hypervisorversion",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the host's CPU currently allocated in MHz",
+ "name": "cpuallocatedvalue",
+ "type": "long"
+ },
+ {
+ "description": "the resource state of the host",
+ "name": "resourcestate",
+ "type": "string"
+ },
+ {
+ "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 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 date and time the host was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the ID of the host",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the Pod name of the host",
+ "name": "podname",
+ "type": "string"
+ },
+ {
+ "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",
+ "type": "string"
+ },
+ {
+ "description": "the number of CPU sockets on the host",
+ "name": "cpusockets",
+ "type": "integer"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the amount of the host's CPU currently used",
+ "name": "cpuused",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
}
]
},
@@ -61708,14 +62615,6 @@
"name": "createRole",
"params": [
{
- "description": "ID of the role to be cloned from. Either roleid or type must be passed in",
- "length": 255,
- "name": "roleid",
- "related": "createRole,importRole,listRoles,updateRole",
- "required": false,
- "type": "uuid"
- },
- {
"description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User",
"length": 255,
"name": "type",
@@ -61723,22 +62622,51 @@
"type": "string"
},
{
- "description": "Creates a role with this unique name",
- "length": 255,
- "name": "name",
- "required": true,
- "type": "string"
- },
- {
"description": "The description of the role",
"length": 255,
"name": "description",
"required": false,
"type": "string"
+ },
+ {
+ "description": "ID of the role to be cloned from. Either roleid or type must be passed in",
+ "length": 255,
+ "name": "roleid",
+ "related": "createRole,importRole,listRoles,updateRole",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "Creates a role with this unique name",
+ "length": 255,
+ "name": "name",
+ "required": true,
+ "type": "string"
}
],
"related": "importRole,listRoles,updateRole",
"response": [
+ {},
+ {
+ "description": "the name of the role",
+ "name": "name",
+ "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": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
{
"description": "the ID of the role",
"name": "id",
@@ -61749,33 +62677,12 @@
"name": "isdefault",
"type": "boolean"
},
- {
- "description": "the description of the role",
- "name": "description",
- "type": "string"
- },
+ {},
{
"description": "the type of the role",
"name": "type",
"type": "string"
- },
- {},
- {
- "description": "the name of the role",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {}
+ }
],
"since": "4.9.0"
},
@@ -61793,28 +62700,28 @@
}
],
"response": [
+ {},
+ {
+ "description": "any text associated with the success or failure",
+ "name": "displaytext",
+ "type": "string"
+ },
+ {},
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
- {},
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
{
- "description": "any text associated with the success or failure",
- "name": "displaytext",
- "type": "string"
- },
- {
"description": "true if operation is executed successfully",
"name": "success",
"type": "boolean"
- },
- {}
+ }
]
},
{
@@ -61832,22 +62739,22 @@
],
"related": "",
"response": [
- {},
- {},
{
"description": "Volume iSCSI Name",
"name": "volumeiScsiName",
"type": "string"
},
+ {},
+ {},
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
}
]
},
@@ -61857,14 +62764,6 @@
"name": "getUploadParamsForVolume",
"params": [
{
- "description": "an optional domainId. If the account parameter is used, domainId must also be used.",
- "length": 255,
- "name": "domainid",
- "related": "listDomainChildren,listDomains",
- "required": false,
- "type": "uuid"
- },
- {
"description": "the ID of the zone the volume/template is to be hosted on",
"length": 255,
"name": "zoneid",
@@ -61873,20 +62772,6 @@
"type": "uuid"
},
{
- "description": "the name of the volume/template",
- "length": 255,
- "name": "name",
- "required": true,
- "type": "string"
- },
- {
- "description": "Image store uuid",
- "length": 255,
- "name": "imagestoreuuid",
- "required": false,
- "type": "string"
- },
- {
"description": "the ID of the disk offering. This must be a custom sized offering since during upload of volume/template size is unknown.",
"length": 255,
"name": "diskofferingid",
@@ -61895,10 +62780,10 @@
"type": "uuid"
},
{
- "description": "Upload volume/template 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,listProjects,suspendProject,updateProject",
+ "name": "domainid",
+ "related": "listDomainChildren,listDomains",
"required": false,
"type": "uuid"
},
@@ -61922,18 +62807,35 @@
"name": "checksum",
"required": false,
"type": "string"
+ },
+ {
+ "description": "Upload volume/template for the project",
+ "length": 255,
+ "name": "projectid",
+ "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "Image store uuid",
+ "length": 255,
+ "name": "imagestoreuuid",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the name of the volume/template",
+ "length": 255,
+ "name": "name",
+ "required": true,
+ "type": "string"
}
],
"related": "getUploadParamsForTemplate,getUploadParamsForIso",
"response": [
{
- "description": "encrypted data to be sent in the POST request.",
- "name": "metadata",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "signature to be sent in the POST request.",
+ "name": "signature",
"type": "string"
},
{},
@@ -61943,24 +62845,29 @@
"type": "url"
},
{
- "description": "the timestamp after which the signature expires",
- "name": "expires",
- "type": "string"
+ "description": "the template/volume ID",
+ "name": "id",
+ "type": "uuid"
},
- {},
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
{
- "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",
+ "description": "encrypted data to be sent in the POST request.",
+ "name": "metadata",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
}
],
@@ -61972,12 +62879,12 @@
"name": "updateAutoScaleVmGroup",
"params": [
{
- "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only",
+ "description": "list of scaledown autoscale policies",
"length": 255,
- "name": "customid",
+ "name": "scaledownpolicyids",
+ "related": "listAutoScalePolicies,updateAutoScalePolicy",
"required": false,
- "since": "4.4",
- "type": "string"
+ "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.",
@@ -61995,6 +62902,21 @@
"type": "uuid"
},
{
+ "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only",
+ "length": 255,
+ "name": "customid",
+ "required": false,
+ "since": "4.4",
+ "type": "string"
+ },
+ {
+ "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.",
+ "length": 255,
+ "name": "maxmembers",
+ "required": false,
+ "type": "integer"
+ },
+ {
"description": "the frequency at which the conditions have to be evaluated",
"length": 255,
"name": "interval",
@@ -62002,22 +62924,6 @@
"type": "integer"
},
{
- "description": "an optional field, whether to the display the group to the end user or not",
- "length": 255,
- "name": "fordisplay",
- "required": false,
- "since": "4.4",
- "type": "boolean"
- },
- {
- "description": "list of scaledown autoscale policies",
- "length": 255,
- "name": "scaledownpolicyids",
- "related": "listAutoScalePolicies,updateAutoScalePolicy",
- "required": false,
- "type": "list"
- },
- {
"description": "list of scaleup autoscale policies",
"length": 255,
"name": "scaleuppolicyids",
@@ -62026,60 +62932,46 @@
"type": "list"
},
{
- "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.",
+ "description": "an optional field, whether to the display the group to the end user or not",
"length": 255,
- "name": "maxmembers",
+ "name": "fordisplay",
"required": false,
- "type": "integer"
+ "since": "4.4",
+ "type": "boolean"
}
],
"related": "enableAutoScaleVmGroup,listAutoScaleVmGroups",
"response": [
- {
- "description": "the project id vm profile",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "is group for display to the regular user",
- "name": "fordisplay",
- "type": "boolean"
- },
{},
{
- "description": "list of scaleup autoscale policies",
- "name": "scaleuppolicies",
- "type": "list"
- },
- {},
- {
- "description": "list of scaledown autoscale policies",
- "name": "scaledownpolicies",
- "type": "list"
- },
- {
- "description": "the project name of the vm profile",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the current state of the AutoScale Vm Group",
- "name": "state",
- "type": "string"
- },
- {
"description": "the account owning the instance group",
"name": "account",
"type": "string"
},
{
- "description": "the frequency at which the conditions have to be evaluated",
- "name": "interval",
- "type": "int"
+ "description": "the project id vm profile",
+ "name": "projectid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "is group for display to the regular user",
+ "name": "fordisplay",
+ "type": "boolean"
},
{
- "description": "the domain ID of the vm profile",
- "name": "domainid",
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the autoscale profile that contains information about the vms in the vm group.",
+ "name": "vmprofileid",
+ "type": "string"
+ },
+ {
+ "description": "the load balancer rule ID",
+ "name": "lbruleid",
"type": "string"
},
{
@@ -62088,24 +62980,19 @@
"type": "int"
},
{
- "description": "the domain name of the vm profile",
- "name": "domain",
+ "description": "the project name of the vm profile",
+ "name": "project",
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the autoscale vm group ID",
+ "name": "id",
"type": "string"
},
{
- "description": "the autoscale profile that contains information about the vms in the vm group.",
- "name": "vmprofileid",
- "type": "string"
+ "description": "list of scaleup autoscale policies",
+ "name": "scaleuppolicies",
+ "type": "list"
},
{
"description": "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.",
@@ -62113,13 +63000,33 @@
"type": "int"
},
{
- "description": "the load balancer rule ID",
- "name": "lbruleid",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
- "description": "the autoscale vm group ID",
- "name": "id",
+ "description": "list of scaledown autoscale policies",
+ "name": "scaledownpolicies",
+ "type": "list"
+ },
+ {
+ "description": "the domain name of the vm profile",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID of the vm profile",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the frequency at which the conditions have to be evaluated",
+ "name": "interval",
+ "type": "int"
+ },
+ {
+ "description": "the current state of the AutoScale Vm Group",
+ "name": "state",
"type": "string"
}
]
@@ -62138,29 +63045,6 @@
"type": "string"
},
{
- "description": "the template of the auto deployed virtual machine",
- "length": 255,
- "name": "templateid",
- "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "the ID of the autoscale vm profile",
- "length": 255,
- "name": "id",
- "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile",
- "required": true,
- "type": "uuid"
- },
- {
- "description": "counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161",
- "length": 255,
- "name": "counterparam",
- "required": false,
- "type": "map"
- },
- {
"description": "the time allowed for existing connections to get closed before a vm is destroyed",
"length": 255,
"name": "destroyvmgraceperiod",
@@ -62182,30 +63066,33 @@
"related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser",
"required": false,
"type": "uuid"
+ },
+ {
+ "description": "the template of the auto deployed virtual machine",
+ "length": 255,
+ "name": "templateid",
+ "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "the ID of the autoscale vm profile",
+ "length": 255,
+ "name": "id",
+ "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile",
+ "required": true,
+ "type": "uuid"
+ },
+ {
+ "description": "counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161",
+ "length": 255,
+ "name": "counterparam",
+ "required": false,
+ "type": "map"
}
],
"related": "createAutoScaleVmProfile,listAutoScaleVmProfiles",
"response": [
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the template to be used while deploying a virtual machine",
- "name": "templateid",
- "type": "string"
- },
- {
- "description": "the account owning the instance group",
- "name": "account",
- "type": "string"
- },
- {
- "description": "is profile for display to the regular user",
- "name": "fordisplay",
- "type": "boolean"
- },
{},
{
"description": "the availability zone to be used while deploying a virtual machine",
@@ -62213,8 +63100,13 @@
"type": "string"
},
{
- "description": "the service offering to be used while deploying a virtual machine",
- "name": "serviceofferingid",
+ "description": "the time allowed for existing connections to get closed before a vm is destroyed",
+ "name": "destroyvmgraceperiod",
+ "type": "integer"
+ },
+ {
+ "description": "the project name of the vm profile",
+ "name": "project",
"type": "string"
},
{
@@ -62223,47 +63115,62 @@
"type": "integer"
},
{
+ "description": "the domain name of the vm profile",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the service offering to be used while deploying a virtual machine",
+ "name": "serviceofferingid",
+ "type": "string"
+ },
+ {
"description": "the autoscale vm profile ID",
"name": "id",
"type": "string"
},
+ {},
+ {
+ "description": "the template to be used while deploying a virtual machine",
+ "name": "templateid",
+ "type": "string"
+ },
{
"description": "the ID of the user used to launch and destroy the VMs",
"name": "autoscaleuserid",
"type": "string"
},
{},
- {},
- {
- "description": "the project id vm profile",
- "name": "projectid",
- "type": "string"
- },
- {},
- {
- "description": "the time allowed for existing connections to get closed before a vm is destroyed",
- "name": "destroyvmgraceperiod",
- "type": "integer"
- },
{
"description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine",
"name": "otherdeployparams",
"type": "string"
},
- {
- "description": "the domain name of the vm profile",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the project name of the vm profile",
- "name": "project",
- "type": "string"
- },
+ {},
{
"description": "the domain ID of the vm profile",
"name": "domainid",
"type": "string"
+ },
+ {
+ "description": "is profile for display to the regular user",
+ "name": "fordisplay",
+ "type": "boolean"
+ },
+ {
+ "description": "the project id vm profile",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the account owning the instance group",
+ "name": "account",
+ "type": "string"
}
]
},
@@ -62284,9 +63191,35 @@
"related": "listAutoScaleVmGroups",
"response": [
{
- "description": "is group for display to the regular user",
- "name": "fordisplay",
- "type": "boolean"
+ "description": "the project id vm profile",
+ "name": "projectid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the load balancer rule ID",
+ "name": "lbruleid",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the vm profile",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the autoscale vm group ID",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the current state of the AutoScale Vm Group",
+ "name": "state",
+ "type": "string"
},
{
"description": "list of scaledown autoscale policies",
@@ -62299,31 +63232,15 @@
"type": "string"
},
{
- "description": "the current state of the AutoScale Vm Group",
- "name": "state",
+ "description": "the autoscale profile that contains information about the vms in the vm group.",
+ "name": "vmprofileid",
"type": "string"
},
{
- "description": "list of scaleup autoscale policies",
- "name": "scaleuppolicies",
- "type": "list"
- },
- {
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
- {
- "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.",
- "name": "minmembers",
- "type": "int"
- },
- {
- "description": "the domain name of the vm profile",
- "name": "domain",
- "type": "string"
- },
- {},
{},
{
"description": "the frequency at which the conditions have to be evaluated",
@@ -62331,33 +63248,23 @@
"type": "int"
},
{
- "description": "the load balancer rule ID",
- "name": "lbruleid",
- "type": "string"
+ "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.",
+ "name": "minmembers",
+ "type": "int"
},
{
- "description": "the project id vm profile",
- "name": "projectid",
- "type": "string"
+ "description": "is group for display to the regular user",
+ "name": "fordisplay",
+ "type": "boolean"
},
{
- "description": "the autoscale vm group ID",
- "name": "id",
- "type": "string"
+ "description": "list of scaleup autoscale policies",
+ "name": "scaleuppolicies",
+ "type": "list"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the autoscale profile that contains information about the vms in the vm group.",
- "name": "vmprofileid",
- "type": "string"
- },
- {
- "description": "the project name of the vm profile",
- "name": "project",
+ "description": "the domain name of the vm profile",
+ "name": "domain",
"type": "string"
},
{
@@ -62387,27 +63294,27 @@
}
],
"response": [
+ {},
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {},
{
"description": "true if operation is executed successfully",
"name": "success",
"type": "boolean"
},
- {},
- {},
- {
- "description": "any text associated with the success or failure",
- "name": "displaytext",
- "type": "string"
- },
{
"description": "the UUID of the latest async job acting on 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"
}
]
},
@@ -62417,21 +63324,148 @@
"name": "listVirtualMachines",
"params": [
{
- "description": "the host ID",
+ "description": "list vms by iso",
"length": 255,
- "name": "hostid",
- "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost",
+ "name": "isoid",
"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": "the storage ID where vm's volumes belong to",
"length": 255,
- "name": "name",
+ "name": "storageid",
+ "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "comma separated list of host details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, iso, volume, min, affgrp]. If no parameter is passed in, the details will be defaulted to all",
+ "length": 255,
+ "name": "details",
+ "required": false,
+ "type": "list"
+ },
+ {
+ "description": "the IDs of the virtual machines, mutually exclusive with id",
+ "length": 255,
+ "name": "ids",
+ "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance",
+ "required": false,
+ "since": "4.4",
+ "type": "list"
+ },
+ {
+ "description": "list by network type; true if need to list vms using Virtual Network, false otherwise",
+ "length": 255,
+ "name": "forvirtualnetwork",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "list vms by template",
+ "length": 255,
+ "name": "templateid",
+ "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "the storage ID where vm's volumes belong to",
+ "length": 255,
+ "name": "storageid",
+ "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "flag to display the resource icon for VMs",
+ "length": 255,
+ "name": "showicon",
+ "required": false,
+ "since": "4.16.0.0",
+ "type": "boolean"
+ },
+ {
+ "description": "list by the service offering",
+ "length": 255,
+ "name": "serviceofferingid",
+ "related": "updateServiceOffering,listServiceOfferings",
+ "required": false,
+ "since": "4.4",
+ "type": "uuid"
+ },
+ {
+ "description": "list only resources belonging to the domain specified",
+ "length": 255,
+ "name": "domainid",
+ "related": "listDomainChildren,listDomains",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "state of the virtual machine. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed.",
+ "length": 255,
+ "name": "state",
"required": false,
"type": "string"
},
{
+ "description": "the security group ID",
+ "length": 255,
+ "name": "securitygroupid",
+ "related": "createSecurityGroup",
+ "required": false,
+ "since": "4.15",
+ "type": "uuid"
+ },
+ {
+ "description": "list vms by affinity group",
+ "length": 255,
+ "name": "affinitygroupid",
+ "related": "",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "list vms by ssh keypair name",
+ "length": 255,
+ "name": "keypair",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the cluster ID",
+ "length": 255,
+ "name": "clusterid",
+ "related": "addCluster,updateCluster",
+ "required": false,
+ "since": "4.16.0",
+ "type": "uuid"
+ },
+ {
+ "description": "the ID of the virtual machine",
+ "length": 255,
+ "name": "id",
+ "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled",
+ "length": 255,
+ "name": "haenable",
+ "required": false,
+ "since": "4.15",
+ "type": "boolean"
+ },
+ {
"description": "the pod ID",
"length": 255,
"name": "podid",
@@ -62440,11 +63474,58 @@
"type": "uuid"
},
{
- "description": "comma separated list of host details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, iso, volume, min, affgrp]. If no parameter is passed in, the details will be defaulted to all",
+ "description": "List resources by tags (key/value pairs)",
"length": 255,
- "name": "details",
+ "name": "tags",
"required": false,
- "type": "list"
+ "type": "map"
+ },
+ {
+ "description": "the host ID",
+ "length": 255,
+ "name": "hostid",
+ "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost",
+ "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",
+ "length": 255,
+ "name": "listall",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter",
+ "length": 255,
+ "name": "displayvm",
+ "required": false,
+ "since": "4.4",
+ "type": "boolean"
+ },
+ {
+ "description": "list by network id",
+ "length": 255,
+ "name": "networkid",
+ "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "the pod ID",
+ "length": 255,
+ "name": "podid",
+ "related": "updatePod,createManagementNetworkIpRange",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "the user ID that created the VM and is under the account that owns the VM",
+ "length": 255,
+ "name": "userid",
+ "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser",
+ "required": false,
+ "type": "uuid"
},
{
"description": "the availability zone ID",
@@ -62462,14 +63543,43 @@
"type": "boolean"
},
{
- "description": "the storage ID where vm's volumes belong to",
+ "description": "the group ID",
"length": 255,
- "name": "storageid",
- "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool",
+ "name": "groupid",
+ "related": "createInstanceGroup",
"required": false,
"type": "uuid"
},
{
+ "description": "name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned)",
+ "length": 255,
+ "name": "name",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the target hypervisor for the template",
+ "length": 255,
+ "name": "hypervisor",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the host ID",
+ "length": 255,
+ "name": "hostid",
+ "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "list vms by vpc",
"length": 255,
"name": "vpcid",
@@ -62478,36 +63588,6 @@
"type": "uuid"
},
{
- "description": "list by network type; true if need to list vms using Virtual Network, false otherwise",
- "length": 255,
- "name": "forvirtualnetwork",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "list by network id",
- "length": 255,
- "name": "networkid",
- "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks",
- "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",
- "length": 255,
- "name": "listall",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "the user ID that created the VM and is under the account that owns the VM",
- "length": 255,
- "name": "userid",
- "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser",
- "required": false,
- "type": "uuid"
- },
- {
"description": "list objects by project",
"length": 255,
"name": "projectid",
@@ -62516,21 +63596,6 @@
"type": "uuid"
},
{
- "description": "the group ID",
- "length": 255,
- "name": "groupid",
- "related": "createInstanceGroup",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "list vms by iso",
- "length": 255,
- "name": "isoid",
- "required": false,
- "type": "uuid"
- },
- {
"description": "list resources by account. Must be used with the domainId parameter.",
"length": 255,
"name": "account",
@@ -62538,472 +63603,27 @@
"type": "string"
},
{
- "description": "list by the service offering",
- "length": 255,
- "name": "serviceofferingid",
- "related": "updateServiceOffering,listServiceOfferings",
- "required": false,
- "since": "4.4",
- "type": "uuid"
- },
- {
- "description": "flag to display the resource icon for VMs",
- "length": 255,
- "name": "showicon",
- "required": false,
- "since": "4.16.0.0",
- "type": "boolean"
- },
- {
- "description": "the host ID",
- "length": 255,
- "name": "hostid",
- "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "list vms by affinity group",
- "length": 255,
- "name": "affinitygroupid",
- "related": "",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "the security group ID",
- "length": 255,
- "name": "securitygroupid",
- "related": "createSecurityGroup",
- "required": false,
- "since": "4.15",
- "type": "uuid"
- },
- {
- "description": "list only resources belonging to the domain specified",
- "length": 255,
- "name": "domainid",
- "related": "listDomainChildren,listDomains",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "list vms by ssh keypair name",
- "length": 255,
- "name": "keypair",
- "required": false,
- "type": "string"
- },
- {
- "description": "",
- "length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
- },
- {
- "description": "the IDs of the virtual machines, mutually exclusive with id",
- "length": 255,
- "name": "ids",
- "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance",
- "required": false,
- "since": "4.4",
- "type": "list"
- },
- {
- "description": "the pod ID",
- "length": 255,
- "name": "podid",
- "related": "updatePod,createManagementNetworkIpRange",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled",
- "length": 255,
- "name": "haenable",
- "required": false,
- "since": "4.15",
- "type": "boolean"
- },
- {
- "description": "List resources by tags (key/value pairs)",
- "length": 255,
- "name": "tags",
- "required": false,
- "type": "map"
- },
- {
- "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 ID of the virtual machine",
- "length": 255,
- "name": "id",
- "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance",
- "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": "state",
- "required": false,
- "type": "string"
- },
- {
- "description": "the storage ID where vm's volumes belong to",
- "length": 255,
- "name": "storageid",
- "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "list vms by template",
- "length": 255,
- "name": "templateid",
- "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "the cluster ID",
- "length": 255,
- "name": "clusterid",
- "related": "addCluster,updateCluster",
- "required": false,
- "since": "4.16.0",
- "type": "uuid"
- },
- {
- "description": "the target hypervisor for the template",
- "length": 255,
- "name": "hypervisor",
- "required": false,
- "type": "string"
- },
- {
"description": "",
"length": 255,
"name": "pagesize",
"required": false,
"type": "integer"
- },
- {
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
}
],
"related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance",
"response": [
{
- "description": "the ID of the domain in which the virtual machine exists",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the name of the ISO attached to the virtual machine",
- "name": "isoname",
- "type": "string"
- },
- {
- "description": " an alternate display text of the template for the virtual machine",
- "name": "templatedisplaytext",
- "type": "string"
- },
- {
- "description": "Vm details in key/value pairs.",
- "name": "details",
- "type": "map"
- },
- {
- "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": "list of affinity groups associated with the virtual machine",
- "name": "affinitygroup",
- "response": [
- {
- "description": "the project name of the affinity group",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the account owning the affinity group",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the project ID of the affinity group",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the domain name of the affinity group",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the ID of the affinity group",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the name of the affinity group",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the type of the affinity group",
- "name": "type",
- "type": "string"
- },
- {
- "description": "virtual machine IDs associated with this affinity group",
- "name": "virtualmachineIds",
- "type": "list"
- },
- {
- "description": "the description of the affinity group",
- "name": "description",
- "type": "string"
- },
- {
- "description": "the domain ID of the affinity group",
- "name": "domainid",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the user's name who deployed the virtual machine",
- "name": "username",
- "type": "string"
- },
- {
- "description": "the vgpu type used by the virtual machine",
- "name": "vgpu",
- "type": "string"
- },
- {
- "description": "the name of the disk offering of the virtual machine",
- "name": "diskofferingname",
- "type": "string"
- },
- {
- "description": "the hypervisor on which the template runs",
- "name": "hypervisor",
- "type": "string"
- },
- {
- "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.",
- "name": "templateid",
- "type": "string"
- },
- {
- "description": "ssh key-pair",
- "name": "keypair",
- "type": "string"
- },
- {
- "description": "the write (io) of disk on the vm",
- "name": "diskiowrite",
- "type": "long"
- },
- {
- "description": "the date when this virtual machine was updated last time",
- "name": "lastupdated",
- "type": "date"
- },
- {
- "description": "the ID of the service offering of the virtual machine",
- "name": "serviceofferingid",
- "type": "string"
- },
- {
"description": "device type of the root volume",
"name": "rootdevicetype",
"type": "string"
},
- {
- "description": "the memory used by the vm",
- "name": "memorykbs",
- "type": "long"
- },
- {
- "description": "the virtual network for the service offering",
- "name": "forvirtualnetwork",
- "type": "boolean"
- },
- {
- "description": "the name of the host for the virtual machine",
- "name": "hostname",
- "type": "string"
- },
- {
- "description": "user generated name. The name of the virtual machine is returned if no displayname exists.",
- "name": "displayname",
- "type": "string"
- },
- {
- "description": "State of the Service from LB rule",
- "name": "servicestate",
- "type": "string"
- },
- {
- "description": "device ID of the root volume",
- "name": "rootdeviceid",
- "type": "long"
- },
- {
- "description": "OS type id of the vm",
- "name": "ostypeid",
- "type": "string"
- },
- {
- "description": "the write (bytes) of disk on the vm",
- "name": "diskkbswrite",
- "type": "long"
- },
- {
- "description": "the ID of the disk offering of the virtual machine",
- "name": "diskofferingid",
- "type": "string"
- },
- {
- "description": "the date when this virtual machine was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "Os type ID of the virtual machine",
- "name": "guestosid",
- "type": "string"
- },
- {
- "description": "the 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": "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 target memory in vm",
- "name": "memorytargetkbs",
- "type": "long"
- },
- {
- "description": "the name of the availability zone for the virtual machine",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "List of read-only Vm details as comma separated string.",
- "name": "readonlydetails",
- "type": "string"
- },
- {
- "description": "the total number of network traffic bytes sent",
- "name": "sentbytes",
- "type": "long"
- },
- {
- "description": "public IP address id associated with vm via Static nat rule",
- "name": "publicipid",
- "type": "string"
- },
- {
- "description": "the ID of the ISO attached to the virtual machine",
- "name": "isoid",
- "type": "string"
- },
- {
- "description": "the name of the virtual machine",
- "name": "name",
- "type": "string"
- },
- {
- "description": "an optional field whether to the display the vm to the end user or not.",
- "name": "displayvm",
- "type": "boolean"
- },
- {
- "description": "true if high-availability is enabled, false otherwise",
- "name": "haenable",
- "type": "boolean"
- },
- {
- "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 password (if exists) of the virtual machine",
"name": "password",
"type": "string"
},
{
- "description": "Guest vm Boot Mode",
- "name": "bootmode",
- "type": "string"
- },
- {
- "description": "OS name of the vm",
- "name": "osdisplayname",
- "type": "string"
- },
- {
- "description": "the group name of the virtual machine",
- "name": "group",
- "type": "string"
- },
- {
- "description": "the number of cpu this virtual machine is running with",
- "name": "cpunumber",
- "type": "integer"
- },
- {
- "description": "instance name of the user vm; this parameter is returned to the ROOT admin only",
- "name": "instancename",
- "type": "string"
- },
- {},
- {
"description": "the ID of the virtual machine",
"name": "id",
"type": "string"
@@ -63014,110 +63634,180 @@
"type": "string"
},
{
- "description": "the name of the service offering of the virtual machine",
- "name": "serviceofferingname",
+ "description": "the name of the host for the virtual machine",
+ "name": "hostname",
"type": "string"
},
{
- "description": "the read (io) of disk on the vm",
- "name": "diskioread",
- "type": "long"
- },
- {
- "description": "the list of resource tags associated",
- "name": "tags",
+ "description": "the list of nics associated with vm",
+ "name": "nic",
"response": [
{
- "description": "id of the resource",
- "name": "resourceid",
+ "description": "the IPv6 address of network",
+ "name": "ip6address",
"type": "string"
},
{
- "description": "resource type",
- "name": "resourcetype",
+ "description": "Type of adapter if available",
+ "name": "adaptertype",
"type": "string"
},
{
- "description": "tag key name",
- "name": "key",
+ "description": "the extra dhcp options on the nic",
+ "name": "extradhcpoption",
+ "type": "list"
+ },
+ {
+ "description": "the broadcast uri of the nic",
+ "name": "broadcasturi",
"type": "string"
},
{
- "description": "tag value",
- "name": "value",
+ "description": "the ip address of the nic",
+ "name": "ipaddress",
"type": "string"
},
{
- "description": "customer associated with the tag",
- "name": "customer",
+ "description": "the gateway of IPv6 network",
+ "name": "ip6gateway",
"type": "string"
},
{
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
+ "description": "the ID of the nic",
+ "name": "id",
"type": "string"
},
{
- "description": "the domain associated with the tag",
- "name": "domain",
+ "description": "true if nic is default, false otherwise",
+ "name": "macaddress",
"type": "string"
},
{
- "description": "the project name where tag belongs to",
- "name": "project",
+ "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise",
+ "name": "nsxlogicalswitchport",
"type": "string"
},
{
- "description": "the account associated with the tag",
- "name": "account",
+ "description": "Id of the NSX Logical Switch (if NSX based), null otherwise",
+ "name": "nsxlogicalswitch",
"type": "string"
},
{
- "description": "the project id the tag belongs to",
- "name": "projectid",
+ "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": "Id of the vm to which the nic belongs",
+ "name": "virtualmachineid",
+ "type": "string"
+ },
+ {
+ "description": "the Secondary ipv4 addr of nic",
+ "name": "secondaryip",
+ "type": "list"
+ },
+ {
+ "description": "the isolated private VLAN if available",
+ "name": "isolatedpvlan",
+ "type": "integer"
+ },
+ {
+ "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 netmask of the nic",
+ "name": "netmask",
+ "type": "string"
+ },
+ {
+ "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": "isdefault",
+ "type": "boolean"
+ },
+ {
+ "description": "the isolation uri of the nic",
+ "name": "isolationuri",
+ "type": "string"
+ },
+ {
+ "description": "the cidr of IPv6 network",
+ "name": "ip6cidr",
+ "type": "string"
+ },
+ {
+ "description": "the name of the corresponding network",
+ "name": "networkname",
+ "type": "string"
+ },
+ {
+ "description": "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 name of the backup offering of the virtual machine",
- "name": "backupofferingname",
- "type": "string"
- },
- {
- "description": "the speed of each cpu",
- "name": "cpuspeed",
- "type": "integer"
- },
- {
- "description": "the read (bytes) of disk on the vm",
- "name": "diskkbsread",
+ "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",
+ "description": "the ID of the disk offering of the virtual machine",
+ "name": "diskofferingid",
"type": "string"
},
{
- "description": "the internal memory that's free in vm or zero if it can not be calculated",
- "name": "memoryintfreekbs",
- "type": "long"
- },
- {
- "description": "the ID of the availablility zone for the virtual machine",
- "name": "zoneid",
+ "description": "the name of the service offering of the virtual machine",
+ "name": "serviceofferingname",
"type": "string"
},
{
- "description": "the name of the domain in which the virtual machine exists",
- "name": "domain",
+ "description": "the group ID of the virtual machine",
+ "name": "groupid",
"type": "string"
},
{
- "description": "the project id of the vm",
- "name": "projectid",
+ "description": "true if high-availability is enabled, false otherwise",
+ "name": "haenable",
+ "type": "boolean"
+ },
+ {
+ "description": "user generated name. The name of the virtual machine is returned if no displayname exists.",
+ "name": "displayname",
+ "type": "string"
+ },
+ {
+ "description": "the vgpu type used by the virtual machine",
+ "name": "vgpu",
"type": "string"
},
{
@@ -63125,31 +63815,24 @@
"name": "account",
"type": "string"
},
- {},
{
- "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 amount of the vm's CPU currently used",
- "name": "cpuused",
+ "description": "the user's ID who deployed the virtual machine",
+ "name": "userid",
"type": "string"
},
{
- "description": "the name of the template for the virtual machine",
- "name": "templatename",
+ "description": "List of read-only Vm details as comma separated string.",
+ "name": "readonlydetails",
"type": "string"
},
{
- "description": "the project name of the vm",
- "name": "project",
+ "description": "public IP address id associated with vm via Static nat rule",
+ "name": "publicip",
+ "type": "string"
+ },
+ {
+ "description": "OS name of the vm",
+ "name": "osdisplayname",
"type": "string"
},
{
@@ -63167,20 +63850,87 @@
"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",
+ "type": "string"
+ },
+ {
+ "description": "the list of resource tags associated with the rule",
+ "name": "tags",
+ "response": [
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "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 key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
"description": "the type of the ICMP message response",
"name": "icmptype",
"type": "integer"
},
{
+ "description": "account owning the security group rule",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the starting IP of the security group rule",
+ "name": "startport",
+ "type": "integer"
+ },
+ {
"description": "the id of the security group rule",
"name": "ruleid",
"type": "string"
@@ -63191,6 +63941,11 @@
"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"
@@ -63199,114 +63954,27 @@
"description": "the code for the ICMP message response",
"name": "icmpcode",
"type": "integer"
- },
- {
- "description": "account owning the security group rule",
- "name": "account",
- "type": "string"
- },
- {
- "description": "security group name",
- "name": "securitygroupname",
- "type": "string"
- },
- {
- "description": "the list of resource tags associated with the rule",
- "name": "tags",
- "response": [
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "the 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 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 name of the security group",
- "name": "name",
- "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": "customer associated with the tag",
- "name": "customer",
+ "description": "the account associated with the tag",
+ "name": "account",
"type": "string"
},
{
- "description": "the account associated with the tag",
- "name": "account",
+ "description": "the project name where tag belongs to",
+ "name": "project",
"type": "string"
},
{
@@ -63320,18 +63988,13 @@
"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 project name where tag belongs to",
- "name": "project",
+ "description": "tag value",
+ "name": "value",
"type": "string"
},
{
@@ -63340,41 +64003,76 @@
"type": "string"
},
{
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
"description": "id of the resource",
"name": "resourceid",
"type": "string"
},
{
- "description": "tag value",
- "name": "value",
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
"type": "string"
}
],
"type": "set"
},
{
+ "description": "the list of virtualmachine ids associated with this securitygroup",
+ "name": "virtualmachineids",
+ "type": "set"
+ },
+ {
"description": "the number of virtualmachines associated with this securitygroup",
"name": "virtualmachinecount",
"type": "integer"
},
{
+ "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 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": "the code for the ICMP message response",
- "name": "icmpcode",
- "type": "integer"
+ "description": "the protocol of the security group rule",
+ "name": "protocol",
+ "type": "string"
+ },
+ {
+ "description": "the id of the security group rule",
+ "name": "ruleid",
+ "type": "string"
+ },
+ {
+ "description": "security group name",
+ "name": "securitygroupname",
+ "type": "string"
+ },
+ {
+ "description": "account owning the security group rule",
+ "name": "account",
+ "type": "string"
},
{
"description": "the CIDR notation for the base IP address of the security group rule",
@@ -63387,9 +64085,9 @@
"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",
@@ -63397,27 +64095,12 @@
"type": "integer"
},
{
- "description": "security group name",
- "name": "securitygroupname",
- "type": "string"
- },
- {
"description": "the list of resource tags associated with the rule",
"name": "tags",
"response": [
{
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
+ "description": "the domain associated with the tag",
+ "name": "domain",
"type": "string"
},
{
@@ -63426,11 +64109,36 @@
"type": "string"
},
{
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
"description": "the project id the tag belongs to",
"name": "projectid",
"type": "string"
},
{
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
"description": "customer associated with the tag",
"name": "customer",
"type": "string"
@@ -63439,54 +64147,44 @@
"description": "tag value",
"name": "value",
"type": "string"
- },
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
}
],
"type": "set"
- },
- {
- "description": "account owning the security group rule",
- "name": "account",
- "type": "string"
}
],
"type": "set"
},
{
- "description": "the description of the security group",
- "name": "description",
+ "description": "the ID of the security group",
+ "name": "id",
"type": "string"
},
{
"description": "the account owning the security group",
"name": "account",
"type": "string"
- },
- {
- "description": "the project name of the group",
- "name": "project",
- "type": "string"
}
],
"type": "set"
},
{
- "description": "Guest vm Boot Type",
- "name": "boottype",
+ "description": "State of the Service from LB rule",
+ "name": "servicestate",
+ "type": "string"
+ },
+ {
+ "description": "the hypervisor on which the template runs",
+ "name": "hypervisor",
+ "type": "string"
+ },
+ {
+ "description": "the outgoing network traffic on the host",
+ "name": "networkkbswrite",
+ "type": "long"
+ },
+ {
+ "description": "the project name of the vm",
+ "name": "project",
"type": "string"
},
{
@@ -63495,13 +64193,38 @@
"type": "long"
},
{
- "description": "the ID of the host for the virtual machine",
- "name": "hostid",
+ "description": "the pool type of the virtual machine",
+ "name": "pooltype",
"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": "the name of the template for the virtual machine",
+ "name": "templatename",
+ "type": "string"
+ },
+ {
+ "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.",
+ "name": "isdynamicallyscalable",
+ "type": "boolean"
+ },
+ {
+ "description": "the date when this virtual machine was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the project id of the vm",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "instance name of the user vm; this parameter is returned to the ROOT admin only",
+ "name": "instancename",
"type": "string"
},
{
@@ -63510,141 +64233,69 @@
"type": "integer"
},
{
- "description": "the list of nics associated with vm",
- "name": "nic",
- "response": [
- {
- "description": "Type of adapter if available",
- "name": "adaptertype",
- "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 isolation uri of the nic",
- "name": "isolationuri",
- "type": "string"
- },
- {
- "description": "the ID of the corresponding network",
- "name": "networkid",
- "type": "string"
- },
- {
- "description": "the isolated private VLAN type if available",
- "name": "isolatedpvlantype",
- "type": "string"
- },
- {
- "description": "the gateway of IPv6 network",
- "name": "ip6gateway",
- "type": "string"
- },
- {
- "description": "true if nic is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
- },
- {
- "description": "the cidr of IPv6 network",
- "name": "ip6cidr",
- "type": "string"
- },
- {
- "description": "the gateway of the nic",
- "name": "gateway",
- "type": "string"
- },
- {
- "description": "true if nic is default, false otherwise",
- "name": "macaddress",
- "type": "string"
- },
- {
- "description": "the broadcast uri of the nic",
- "name": "broadcasturi",
- "type": "string"
- },
- {
- "description": "the netmask of the nic",
- "name": "netmask",
- "type": "string"
- },
- {
- "description": "the Secondary ipv4 addr of nic",
- "name": "secondaryip",
- "type": "list"
- },
- {
- "description": "the ID of the nic",
- "name": "id",
- "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": "ID of the VLAN/VNI if available",
- "name": "vlanid",
- "type": "integer"
- },
- {
- "description": "the isolated private VLAN if available",
- "name": "isolatedpvlan",
- "type": "integer"
- },
- {
- "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": "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 ip address of the nic",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "description": "Id of the NSX Logical Switch (if NSX based), null otherwise",
- "name": "nsxlogicalswitch",
- "type": "string"
- }
- ],
- "type": "set"
+ "description": "public IP address id associated with vm via Static nat rule",
+ "name": "publicipid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the ISO attached to the virtual machine",
+ "name": "isoname",
+ "type": "string"
+ },
+ {
+ "description": "the write (bytes) of disk on the vm",
+ "name": "diskkbswrite",
+ "type": "long"
+ },
+ {
+ "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": "the amount of the vm's CPU currently used",
+ "name": "cpuused",
+ "type": "string"
+ },
+ {
+ "description": "the name of the domain in which the virtual machine exists",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the read (io) of disk on the vm",
+ "name": "diskioread",
+ "type": "long"
+ },
+ {
+ "description": "the user's name who deployed the virtual machine",
+ "name": "username",
+ "type": "string"
+ },
+ {
+ "description": "the memory used by the vm",
+ "name": "memorykbs",
+ "type": "long"
+ },
+ {
+ "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.",
+ "name": "templateid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the service offering of the virtual machine",
+ "name": "serviceofferingid",
+ "type": "string"
},
{
"description": "the ID of the backup offering of the virtual machine",
@@ -63652,10 +64303,266 @@
"type": "string"
},
{
- "description": "the pool type of the virtual machine",
- "name": "pooltype",
+ "description": "the target memory in vm",
+ "name": "memorytargetkbs",
+ "type": "long"
+ },
+ {
+ "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 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 read (bytes) of disk on the vm",
+ "name": "diskkbsread",
+ "type": "long"
+ },
+ {
+ "description": "the name of the backup offering of the virtual machine",
+ "name": "backupofferingname",
+ "type": "string"
+ },
+ {
+ "description": "the internal memory that's free in vm or zero if it can not be calculated",
+ "name": "memoryintfreekbs",
+ "type": "long"
+ },
+ {
+ "description": "an alternate display text of the ISO attached to the virtual machine",
+ "name": "isodisplaytext",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the availablility zone for the virtual machine",
+ "name": "zoneid",
+ "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": " an alternate display text of the template for the virtual machine",
+ "name": "templatedisplaytext",
+ "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 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": "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": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {},
+ {
+ "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": "list of affinity groups associated with the virtual machine",
+ "name": "affinitygroup",
+ "response": [
+ {
+ "description": "the account owning the affinity group",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the affinity group",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the project ID of the affinity group",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the description of the affinity group",
+ "name": "description",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID of the affinity group",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the type of the affinity group",
+ "name": "type",
+ "type": "string"
+ },
+ {
+ "description": "the name of the affinity group",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the domain name of the affinity group",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the affinity group",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "virtual machine IDs associated with this affinity group",
+ "name": "virtualmachineIds",
+ "type": "list"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the number of cpu this virtual machine is running with",
+ "name": "cpunumber",
+ "type": "integer"
+ },
+ {
+ "description": "the write (io) of disk on the vm",
+ "name": "diskiowrite",
+ "type": "long"
+ },
+ {
+ "description": "Guest vm Boot Type",
+ "name": "boottype",
+ "type": "string"
+ },
+ {
+ "description": "the name of the availability zone for the virtual machine",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "an optional field whether to the display the vm to the end user or not.",
+ "name": "displayvm",
+ "type": "boolean"
+ },
+ {
+ "description": "the group name of the virtual machine",
+ "name": "group",
+ "type": "string"
+ },
+ {
+ "description": "Guest vm Boot Mode",
+ "name": "bootmode",
+ "type": "string"
+ },
+ {
+ "description": "ssh key-pair",
+ "name": "keypair",
+ "type": "string"
+ },
+ {
+ "description": "the name of the disk offering of the virtual machine",
+ "name": "diskofferingname",
+ "type": "string"
+ },
+ {
+ "description": "device ID of the root volume",
+ "name": "rootdeviceid",
+ "type": "long"
+ },
+ {
+ "description": "the speed of each cpu",
+ "name": "cpuspeed",
+ "type": "integer"
+ },
+ {
+ "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"
+ },
+ {}
]
},
{
@@ -63664,19 +64571,19 @@
"name": "updateGuestOsMapping",
"params": [
{
+ "description": "Hypervisor specific name for this Guest OS",
+ "length": 255,
+ "name": "osnameforhypervisor",
+ "required": true,
+ "type": "string"
+ },
+ {
"description": "UUID of the Guest OS to hypervisor name Mapping",
"length": 255,
"name": "id",
"related": "updateGuestOsMapping",
"required": true,
"type": "uuid"
- },
- {
- "description": "Hypervisor specific name for this Guest OS",
- "length": 255,
- "name": "osnameforhypervisor",
- "required": true,
- "type": "string"
}
],
"related": "",
@@ -63687,8 +64594,29 @@
"type": "string"
},
{
- "description": "standard display name for the Guest OS",
- "name": "osdisplayname",
+ "description": "is the mapping user defined",
+ "name": "isuserdefined",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "version of the hypervisor for mapping",
+ "name": "hypervisorversion",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the hypervisor",
+ "name": "hypervisor",
+ "type": "string"
+ },
+ {
+ "description": "hypervisor specific name for the Guest OS",
+ "name": "osnameforhypervisor",
"type": "string"
},
{
@@ -63703,29 +64631,8 @@
},
{},
{
- "description": "is the mapping user defined",
- "name": "isuserdefined",
- "type": "string"
- },
- {
- "description": "hypervisor specific name for the Guest OS",
- "name": "osnameforhypervisor",
- "type": "string"
- },
- {},
- {
- "description": "the hypervisor",
- "name": "hypervisor",
- "type": "string"
- },
- {
- "description": "version of the hypervisor for mapping",
- "name": "hypervisorversion",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "standard display name for the Guest OS",
+ "name": "osdisplayname",
"type": "string"
}
],
@@ -63737,19 +64644,17 @@
"name": "listDiskOfferings",
"params": [
{
- "description": "id of zone disk offering is associated with",
+ "description": "",
"length": 255,
- "name": "zoneid",
- "related": "createZone,updateZone,listZones,listZones",
+ "name": "page",
"required": false,
- "since": "4.13",
- "type": "uuid"
+ "type": "integer"
},
{
- "description": "ID of the disk offering",
+ "description": "list only resources belonging to the domain specified",
"length": 255,
- "name": "id",
- "related": "createDiskOffering,listDiskOfferings",
+ "name": "domainid",
+ "related": "listDomainChildren,listDomains",
"required": false,
"type": "uuid"
},
@@ -63761,19 +64666,20 @@
"type": "boolean"
},
{
- "description": "List by keyword",
+ "description": "id of zone disk offering is associated with",
"length": 255,
- "name": "keyword",
+ "name": "zoneid",
+ "related": "createZone,updateZone,listZones,listZones",
"required": false,
- "type": "string"
+ "since": "4.13",
+ "type": "uuid"
},
{
- "description": "list only resources belonging to the domain specified",
+ "description": "name of the disk offering",
"length": 255,
- "name": "domainid",
- "related": "listDomainChildren,listDomains",
+ "name": "name",
"required": false,
- "type": "uuid"
+ "type": "string"
},
{
"description": "",
@@ -63783,11 +64689,19 @@
"type": "integer"
},
{
- "description": "",
+ "description": "List by keyword",
"length": 255,
- "name": "page",
+ "name": "keyword",
"required": false,
- "type": "integer"
+ "type": "string"
+ },
+ {
+ "description": "ID of the disk offering",
+ "length": 255,
+ "name": "id",
+ "related": "createDiskOffering,listDiskOfferings",
+ "required": false,
+ "type": "uuid"
},
{
"description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false",
@@ -63795,131 +64709,48 @@
"name": "listall",
"required": false,
"type": "boolean"
- },
- {
- "description": "name of the disk offering",
- "length": 255,
- "name": "name",
- "required": false,
- "type": "string"
}
],
"related": "createDiskOffering",
"response": [
{
- "description": "an alternate display text of the disk offering.",
- "name": "displaytext",
- "type": "string"
- },
- {
- "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",
- "type": "string"
- },
- {
- "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the name of the disk offering",
- "name": "name",
- "type": "string"
- },
- {
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "true if disk offering uses custom iops, false otherwise",
- "name": "iscustomizediops",
- "type": "boolean"
- },
- {
- "description": "burst bytes read rate of the disk offering",
- "name": "diskBytesReadRateMax",
- "type": "long"
- },
- {
- "description": "whether to display the offering to the end user or not.",
- "name": "displayoffering",
- "type": "boolean"
- },
- {
- "description": "the cache mode to use for this disk offering. none, writeback or writethrough",
- "name": "cacheMode",
- "type": "string"
- },
- {
- "description": "length (in second) of the burst",
- "name": "diskIopsReadRateMaxLength",
- "type": "long"
- },
- {
- "description": "length (in seconds) of the burst",
- "name": "diskBytesReadRateMaxLength",
- "type": "long"
- },
- {
- "description": "the vsphere storage policy tagged to the disk offering in case of VMware",
- "name": "vspherestoragepolicy",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {},
- {
- "description": "bytes read rate of the disk offering",
- "name": "diskBytesReadRate",
- "type": "long"
- },
- {
"description": "io requests write rate of the disk offering",
"name": "diskIopsWriteRate",
"type": "long"
},
{
- "description": "io requests read rate of the disk offering",
- "name": "diskIopsReadRate",
- "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": "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"
},
{
- "description": "burst io requests write rate of the disk offering",
- "name": "diskIopsWriteRateMax",
+ "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": "the cache mode to use for this disk offering. none, writeback or writethrough",
+ "name": "cacheMode",
+ "type": "string"
+ },
+ {
+ "description": "the storage type for this disk offering",
+ "name": "storagetype",
+ "type": "string"
+ },
+ {
+ "description": "burst bytes read rate of the disk offering",
+ "name": "diskBytesReadRateMax",
"type": "long"
},
{
- "description": "length (in seconds) of the burst",
- "name": "diskBytesWriteRateMaxLength",
+ "description": "bytes write rate of the disk offering",
+ "name": "diskBytesWriteRate",
"type": "long"
},
{
@@ -63928,8 +64759,24 @@
"type": "long"
},
{
- "description": "unique ID of the disk offering",
- "name": "id",
+ "description": "length (in seconds) of the burst",
+ "name": "diskIopsWriteRateMaxLength",
+ "type": "long"
+ },
+ {},
+ {
+ "description": "burst io requests read rate of the disk offering",
+ "name": "diskIopsReadRateMax",
+ "type": "long"
+ },
+ {
+ "description": "the vsphere storage policy tagged to the disk offering in case of VMware",
+ "name": "vspherestoragepolicy",
+ "type": "string"
+ },
+ {
+ "description": "the tags for the disk offering",
+ "name": "tags",
"type": "string"
},
{
@@ -63938,28 +64785,34 @@
"type": "boolean"
},
{
- "description": "the tags for the disk offering",
- "name": "tags",
- "type": "string"
+ "description": "true if disk offering uses custom iops, false otherwise",
+ "name": "iscustomizediops",
+ "type": "boolean"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the date this disk offering was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "bytes write rate of the disk offering",
- "name": "diskBytesWriteRate",
+ "description": "burst io requests write rate of the disk offering",
+ "name": "diskIopsWriteRateMax",
"type": "long"
},
{
- "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
- "name": "zoneid",
+ "description": "length (in second) of the burst",
+ "name": "diskIopsReadRateMaxLength",
+ "type": "long"
+ },
+ {
+ "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
+ "name": "domain",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "unique ID of the disk offering",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "an alternate display text of the disk offering.",
+ "name": "displaytext",
"type": "string"
},
{
@@ -63968,20 +64821,74 @@
"type": "long"
},
{
+ "description": "length (in seconds) of the burst",
+ "name": "diskBytesWriteRateMaxLength",
+ "type": "long"
+ },
+ {
+ "description": "bytes read rate of the disk offering",
+ "name": "diskBytesReadRate",
+ "type": "long"
+ },
+ {
+ "description": "whether to display the offering to the end user or not.",
+ "name": "displayoffering",
+ "type": "boolean"
+ },
+ {
+ "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.",
+ "name": "provisioningtype",
+ "type": "string"
+ },
+ {
+ "description": "io requests read rate of the disk offering",
+ "name": "diskIopsReadRate",
+ "type": "long"
+ },
+ {
"description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
"name": "domainid",
"type": "string"
},
- {},
{
- "description": "the storage type for this disk offering",
- "name": "storagetype",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the size of the disk offering in GB",
+ "name": "disksize",
+ "type": "long"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the date this disk offering was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the name of the disk offering",
+ "name": "name",
"type": "string"
},
{
"description": "the min iops of the disk offering",
"name": "miniops",
"type": "long"
+ },
+ {
+ "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
+ "name": "zone",
+ "type": "string"
+ },
+ {
+ "description": "length (in seconds) of the burst",
+ "name": "diskBytesReadRateMaxLength",
+ "type": "long"
}
]
},
@@ -63991,9 +64898,9 @@
"name": "updateHostPassword",
"params": [
{
- "description": "the username for the host/cluster",
+ "description": "the new password for the host/cluster",
"length": 255,
- "name": "username",
+ "name": "password",
"required": true,
"type": "string"
},
@@ -64005,17 +64912,9 @@
"type": "boolean"
},
{
- "description": "the host ID",
+ "description": "the username for the host/cluster",
"length": 255,
- "name": "hostid",
- "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "the new password for the host/cluster",
- "length": 255,
- "name": "password",
+ "name": "username",
"required": true,
"type": "string"
},
@@ -64026,22 +64925,18 @@
"related": "addCluster,updateCluster",
"required": false,
"type": "uuid"
+ },
+ {
+ "description": "the host ID",
+ "length": 255,
+ "name": "hostid",
+ "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost",
+ "required": false,
+ "type": "uuid"
}
],
"response": [
{
- "description": "any text associated with the success or failure",
- "name": "displaytext",
- "type": "string"
- },
- {},
- {},
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
"description": "true if operation is executed successfully",
"name": "success",
"type": "boolean"
@@ -64050,7 +64945,19 @@
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
- }
+ },
+ {},
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "any text associated with the success or failure",
+ "name": "displaytext",
+ "type": "string"
+ },
+ {}
]
},
{
@@ -64059,34 +64966,6 @@
"name": "createPortableIpRange",
"params": [
{
- "description": "the beginning IP address in the portable IP range",
- "length": 255,
- "name": "startip",
- "required": true,
- "type": "string"
- },
- {
- "description": "VLAN id, if not specified defaulted to untagged",
- "length": 255,
- "name": "vlan",
- "required": false,
- "type": "string"
- },
- {
- "description": "the netmask of the portable IP range",
- "length": 255,
- "name": "netmask",
- "required": true,
- "type": "string"
- },
- {
- "description": "the gateway for the portable IP range",
- "length": 255,
- "name": "gateway",
- "required": true,
- "type": "string"
- },
- {
"description": "Id of the Region",
"length": 255,
"name": "regionid",
@@ -64100,23 +64979,71 @@
"name": "endip",
"required": true,
"type": "string"
+ },
+ {
+ "description": "the gateway for the portable IP range",
+ "length": 255,
+ "name": "gateway",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "VLAN id, if not specified defaulted to untagged",
+ "length": 255,
+ "name": "vlan",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the beginning IP address in the portable IP range",
+ "length": 255,
+ "name": "startip",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "the netmask of the portable IP range",
+ "length": 255,
+ "name": "netmask",
+ "required": true,
+ "type": "string"
}
],
"related": "",
"response": [
{
+ "description": "portable IP range ID",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the gateway of the VLAN IP range",
+ "name": "gateway",
+ "type": "string"
+ },
+ {
"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": "the end ip of the portable IP range",
+ "name": "endip",
+ "type": "string"
+ },
+ {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
{
- "description": "portable IP range ID",
- "name": "id",
+ "description": "the ID or VID of the VLAN.",
+ "name": "vlan",
"type": "string"
},
{},
@@ -64131,8 +65058,28 @@
"name": "portableipaddress",
"response": [
{
- "description": "public IP address",
- "name": "ipaddress",
+ "description": "the ID of the Network where ip belongs to",
+ "name": "networkid",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID the portable IP address is associated with",
+ "name": "domainid",
+ "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": "VPC the ip belongs to",
+ "name": "vpcid",
"type": "string"
},
{
@@ -64141,16 +65088,16 @@
"type": "string"
},
{
- "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",
+ "type": "string"
+ },
+ {
"description": "the physical network this belongs to",
"name": "physicalnetworkid",
"type": "string"
@@ -64159,26 +65106,6 @@
"description": "the account ID the portable IP address is associated with",
"name": "accountid",
"type": "string"
- },
- {
- "description": "the ID of the Network where ip belongs to",
- "name": "networkid",
- "type": "string"
- },
- {
- "description": "the domain ID the portable IP address is associated with",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "VPC the ip belongs to",
- "name": "vpcid",
- "type": "string"
- },
- {
- "description": "date the portal IP address was acquired",
- "name": "allocated",
- "type": "date"
}
],
"type": "list"
@@ -64187,26 +65114,6 @@
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
- },
- {
- "description": "the end ip of the portable IP range",
- "name": "endip",
- "type": "string"
- },
- {
- "description": "the ID or VID of the VLAN.",
- "name": "vlan",
- "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"
}
],
"since": "4.2.0"
@@ -64217,6 +65124,13 @@
"name": "updateCluster",
"params": [
{
+ "description": "Allocation state of this cluster for allocation of new resources",
+ "length": 255,
+ "name": "allocationstate",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "hypervisor type of the cluster",
"length": 255,
"name": "clustertype",
@@ -64224,6 +65138,13 @@
"type": "string"
},
{
+ "description": "whether this cluster is managed by cloudstack",
+ "length": 255,
+ "name": "managedstate",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "hypervisor type of the cluster",
"length": 255,
"name": "hypervisor",
@@ -64231,18 +65152,12 @@
"type": "string"
},
{
- "description": "whether this cluster is managed by cloudstack",
+ "description": "the ID of the Cluster",
"length": 255,
- "name": "managedstate",
- "required": false,
- "type": "string"
- },
- {
- "description": "Allocation state of this cluster for allocation of new resources",
- "length": 255,
- "name": "allocationstate",
- "required": false,
- "type": "string"
+ "name": "id",
+ "related": "addCluster,updateCluster",
+ "required": true,
+ "type": "uuid"
},
{
"description": "the cluster name",
@@ -64250,21 +65165,13 @@
"name": "clustername",
"required": false,
"type": "string"
- },
- {
- "description": "the ID of the Cluster",
- "length": 255,
- "name": "id",
- "related": "addCluster,updateCluster",
- "required": true,
- "type": "uuid"
}
],
"related": "addCluster",
"response": [
{
- "description": "the cluster ID",
- "name": "id",
+ "description": "the allocation state of the cluster",
+ "name": "allocationstate",
"type": "string"
},
{
@@ -64272,29 +65179,30 @@
"name": "managedstate",
"type": "string"
},
+ {},
+ {
+ "description": "Meta data associated with the zone (key/value pairs)",
+ "name": "resourcedetails",
+ "type": "map"
+ },
+ {
+ "description": "the type of the cluster",
+ "name": "clustertype",
+ "type": "string"
+ },
+ {
+ "description": "The memory overcommit ratio of the cluster",
+ "name": "memoryovercommitratio",
+ "type": "string"
+ },
{
"description": "the Zone ID of the cluster",
"name": "zoneid",
"type": "string"
},
{
- "description": "the Zone name of the cluster",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "the Pod ID of the cluster",
- "name": "podid",
- "type": "string"
- },
- {
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "The cpu overcommit ratio of the cluster",
+ "name": "cpuovercommitratio",
"type": "string"
},
{
@@ -64303,29 +65211,33 @@
"type": "string"
},
{
- "description": "the cluster name",
- "name": "name",
+ "description": "the cluster ID",
+ "name": "id",
"type": "string"
},
- {},
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
{
- "description": "the type of the cluster",
- "name": "clustertype",
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the hypervisor type of the cluster",
+ "name": "hypervisortype",
"type": "string"
},
{
- "description": "Ovm3 VIP to use for pooling and/or clustering",
- "name": "ovm3vip",
+ "description": "the Pod ID of the cluster",
+ "name": "podid",
"type": "string"
},
{
- "description": "The cpu overcommit ratio of the cluster",
- "name": "cpuovercommitratio",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
@@ -64333,13 +65245,13 @@
"name": "capacity",
"response": [
{
- "description": "the Cluster name",
- "name": "clustername",
- "type": "string"
+ "description": "the capacity type",
+ "name": "type",
+ "type": "short"
},
{
- "description": "the capacity name",
- "name": "name",
+ "description": "the Zone name",
+ "name": "zonename",
"type": "string"
},
{
@@ -64348,21 +65260,6 @@
"type": "string"
},
{
- "description": "the capacity currently in allocated",
- "name": "capacityallocated",
- "type": "long"
- },
- {
- "description": "the Cluster ID",
- "name": "clusterid",
- "type": "string"
- },
- {
- "description": "the total capacity available",
- "name": "capacitytotal",
- "type": "long"
- },
- {
"description": "the Pod name",
"name": "podname",
"type": "string"
@@ -64378,44 +65275,54 @@
"type": "string"
},
{
- "description": "the capacity type",
- "name": "type",
- "type": "short"
+ "description": "the capacity name",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the Cluster name",
+ "name": "clustername",
+ "type": "string"
+ },
+ {
+ "description": "the capacity currently in allocated",
+ "name": "capacityallocated",
+ "type": "long"
+ },
+ {
+ "description": "the total capacity available",
+ "name": "capacitytotal",
+ "type": "long"
+ },
+ {
+ "description": "the Cluster ID",
+ "name": "clusterid",
+ "type": "string"
},
{
"description": "the percentage of capacity currently in use",
"name": "percentused",
"type": "string"
- },
- {
- "description": "the Zone name",
- "name": "zonename",
- "type": "string"
}
],
"type": "list"
},
{
- "description": "the hypervisor type of the cluster",
- "name": "hypervisortype",
+ "description": "the cluster name",
+ "name": "name",
"type": "string"
},
{
- "description": "the allocation state of the cluster",
- "name": "allocationstate",
+ "description": "Ovm3 VIP to use for pooling and/or clustering",
+ "name": "ovm3vip",
"type": "string"
},
+ {},
{
- "description": "The memory overcommit ratio of the cluster",
- "name": "memoryovercommitratio",
+ "description": "the Zone name of the cluster",
+ "name": "zonename",
"type": "string"
- },
- {
- "description": "Meta data associated with the zone (key/value pairs)",
- "name": "resourcedetails",
- "type": "map"
- },
- {}
+ }
]
},
{
@@ -64433,7 +65340,6 @@
}
],
"response": [
- {},
{
"description": "any text associated with the success or failure",
"name": "displaytext",
@@ -64445,16 +65351,220 @@
"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": "Upgrades a running Kubernetes cluster",
+ "isasync": true,
+ "name": "upgradeKubernetesCluster",
+ "params": [
+ {
+ "description": "the ID of the Kubernetes version for upgrade",
+ "length": 255,
+ "name": "kubernetesversionid",
+ "related": "listKubernetesSupportedVersions",
+ "required": true,
+ "type": "uuid"
+ },
+ {
+ "description": "the ID of the Kubernetes cluster",
+ "length": 255,
+ "name": "id",
+ "related": "createKubernetesCluster,startKubernetesCluster,upgradeKubernetesCluster",
+ "required": true,
+ "type": "uuid"
+ }
+ ],
+ "related": "createKubernetesCluster,startKubernetesCluster",
+ "response": [
+ {
+ "description": "the name of the Kubernetes cluster",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "Whether autoscaling is enabled for the cluster",
+ "name": "autoscalingenabled",
+ "type": "boolean"
+ },
+ {
+ "description": "the name of the network of the Kubernetes cluster",
+ "name": "associatednetworkname",
+ "type": "string"
+ },
+ {
+ "description": "the id of the Kubernetes cluster",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the state of the Kubernetes cluster",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "Maximum size of the cluster",
+ "name": "maxsize",
+ "type": "long"
+ },
+ {
+ "description": "the ID of the network of the Kubernetes cluster",
+ "name": "networkid",
+ "type": "string"
+ },
{
"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",
+ "type": "string"
+ },
+ {
+ "description": "the name of the Kubernetes version for the Kubernetes cluster",
+ "name": "kubernetesversionname",
+ "type": "string"
+ },
+ {
+ "description": "the name of the zone of the Kubernetes cluster",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the Kubernetes cluster",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the size (worker nodes count) of the Kubernetes cluster",
+ "name": "size",
+ "type": "long"
+ },
+ {
+ "description": "the ID of the service offering of the Kubernetes cluster",
+ "name": "serviceofferingid",
+ "type": "string"
+ },
+ {
+ "description": "keypair details",
+ "name": "keypair",
+ "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 cpu cores of the Kubernetes cluster",
+ "name": "cpunumber",
+ "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 Kubernetes cluster exists",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the template of the Kubernetes cluster",
+ "name": "templateid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the project id of the Kubernetes cluster",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "URL end point for the Kubernetes cluster",
+ "name": "endpoint",
+ "type": "string"
+ },
+ {
+ "description": "Minimum size of the cluster",
+ "name": "minsize",
+ "type": "long"
+ },
+ {
+ "description": "the name of the domain in which the Kubernetes cluster exists",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the name of the zone of the Kubernetes cluster",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "the control nodes count for the Kubernetes cluster",
+ "name": "controlnodes",
+ "type": "long"
+ },
+ {
+ "description": "the account associated with the Kubernetes cluster",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the name of the service offering of the Kubernetes cluster",
+ "name": "serviceofferingname",
+ "type": "string"
+ },
+ {
+ "description": "the memory the Kubernetes cluster",
+ "name": "memory",
+ "type": "string"
+ },
+ {
+ "description": "the description of the Kubernetes cluster",
+ "name": "description",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the Kubernetes version for the Kubernetes cluster",
+ "name": "kubernetesversionid",
+ "type": "string"
+ },
+ {
+ "description": "Public IP Address ID of the cluster",
+ "name": "ipaddressid",
+ "type": "string"
+ },
+ {
+ "description": "the list of virtualmachine associated with this Kubernetes cluster",
+ "name": "virtualmachines",
+ "type": "list"
+ }
]
},
{
@@ -64463,18 +65573,11 @@
"name": "listStorageProviders",
"params": [
{
- "description": "List by keyword",
+ "description": "",
"length": 255,
- "name": "keyword",
+ "name": "page",
"required": false,
- "type": "string"
- },
- {
- "description": "the type of storage provider: either primary or image",
- "length": 255,
- "name": "type",
- "required": true,
- "type": "string"
+ "type": "integer"
},
{
"description": "",
@@ -64484,18 +65587,26 @@
"type": "integer"
},
{
- "description": "",
+ "description": "the type of storage provider: either primary or image",
"length": 255,
- "name": "page",
+ "name": "type",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
"required": false,
- "type": "integer"
+ "type": "string"
}
],
"related": "",
"response": [
+ {},
{
- "description": "the type of the storage provider: primary or image provider",
- "name": "type",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
@@ -64504,11 +65615,10 @@
"type": "integer"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the type of the storage provider: primary or image provider",
+ "name": "type",
"type": "string"
},
- {},
{
"description": "the name of the storage provider",
"name": "name",
@@ -64523,9 +65633,16 @@
"name": "listUcsProfiles",
"params": [
{
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "",
"length": 255,
- "name": "page",
+ "name": "pagesize",
"required": false,
"type": "integer"
},
@@ -64540,36 +65657,29 @@
{
"description": "",
"length": 255,
- "name": "pagesize",
+ "name": "page",
"required": false,
"type": "integer"
- },
- {
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
}
],
"related": "",
"response": [
- {},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
+ {},
+ {},
{
"description": "ucs profile dn",
"name": "ucsdn",
"type": "string"
},
- {},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
}
]
},
@@ -64589,28 +65699,28 @@
],
"related": "registerUserKeys",
"response": [
+ {},
{
"description": "the api key of the registered user",
"name": "apikey",
"type": "string"
},
{
+ "description": "the secret key of the registered user",
+ "name": "secretkey",
+ "type": "string"
+ },
+ {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
- {},
- {},
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
- {
- "description": "the secret key of the registered user",
- "name": "secretkey",
- "type": "string"
- }
+ {}
],
"since": "4.10.0"
},
@@ -64652,13 +65762,13 @@
"related": "",
"response": [
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "session persistence method used for the global load balancer",
+ "name": "gslbstickysessionmethodname",
"type": "string"
},
{
- "description": "global load balancer rule ID",
- "name": "id",
+ "description": "DNS domain name given for the global load balancer",
+ "name": "gslbdomainname",
"type": "string"
},
{
@@ -64666,64 +65776,80 @@
"name": "jobstatus",
"type": "integer"
},
+ {},
+ {},
{
- "description": "session persistence method used for the global load balancer",
- "name": "gslbstickysessionmethodname",
+ "description": "the project name of the load balancer",
+ "name": "project",
"type": "string"
},
- {},
+ {
+ "description": "Load balancing method used for the global load balancer",
+ "name": "gslblbmethod",
+ "type": "string"
+ },
+ {
+ "description": "the domain of the load balancer rule",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the project id of the load balancer",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "Region Id in which global load balancer is created",
+ "name": "regionid",
+ "type": "integer"
+ },
+ {
+ "description": "the domain ID of the load balancer rule",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "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": "GSLB service type",
+ "name": "gslbservicetype",
+ "type": "string"
+ },
+ {
+ "description": "name of the global load balancer rule",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the description of the global load balancer rule",
+ "name": "description",
+ "type": "string"
+ },
{
"description": "List of load balancer rules that are part of GSLB rule",
"name": "loadbalancerrule",
"response": [
{
- "description": "the name of the zone the load balancer rule belongs to",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "the project id of the load balancer",
- "name": "projectid",
- "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 domain of the load balancer rule",
- "name": "domain",
- "type": "string"
- },
- {
"description": "the name of the load balancer",
"name": "name",
"type": "string"
},
{
- "description": "the public ip address id",
- "name": "publicipid",
- "type": "string"
- },
- {
"description": "the protocol of the loadbalanacer rule",
"name": "protocol",
"type": "string"
},
{
- "description": "the load balancer algorithm (source, roundrobin, leastconn)",
- "name": "algorithm",
- "type": "string"
- },
- {
- "description": "the public ip address",
- "name": "publicip",
+ "description": "the id of the zone the rule belongs to",
+ "name": "zoneid",
"type": "string"
},
{
@@ -64732,8 +65858,8 @@
"type": "string"
},
{
- "description": "the id of the zone the rule belongs to",
- "name": "zoneid",
+ "description": "the load balancer algorithm (source, roundrobin, leastconn)",
+ "name": "algorithm",
"type": "string"
},
{
@@ -64742,13 +65868,38 @@
"type": "string"
},
{
- "description": "the private port",
- "name": "privateport",
+ "description": "the domain of the load balancer rule",
+ "name": "domain",
"type": "string"
},
{
- "description": "the project name of the load balancer",
- "name": "project",
+ "description": "the public ip address",
+ "name": "publicip",
+ "type": "string"
+ },
+ {
+ "description": "the state of the rule",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID of the load balancer rule",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the load balancer rule ID",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the public ip address id",
+ "name": "publicipid",
+ "type": "string"
+ },
+ {
+ "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).",
+ "name": "cidrlist",
"type": "string"
},
{
@@ -64756,18 +65907,23 @@
"name": "tags",
"response": [
{
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
"description": "tag value",
"name": "value",
"type": "string"
},
{
- "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"
},
{
@@ -64776,8 +65932,8 @@
"type": "string"
},
{
- "description": "id of the resource",
- "name": "resourceid",
+ "description": "resource type",
+ "name": "resourcetype",
"type": "string"
},
{
@@ -64796,11 +65952,6 @@
"type": "string"
},
{
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
"description": "customer associated with the tag",
"name": "customer",
"type": "string"
@@ -64809,8 +65960,8 @@
"type": "list"
},
{
- "description": "the domain ID of the load balancer rule",
- "name": "domainid",
+ "description": "the name of the zone the load balancer rule belongs to",
+ "name": "zonename",
"type": "string"
},
{
@@ -64819,79 +65970,38 @@
"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 public port",
"name": "publicport",
"type": "string"
},
{
- "description": "the state of the rule",
- "name": "state",
+ "description": "the project name of the load balancer",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the id of the guest network the lb rule belongs to",
+ "name": "networkid",
+ "type": "string"
+ },
+ {
+ "description": "the private port",
+ "name": "privateport",
+ "type": "string"
+ },
+ {
+ "description": "the project id of the load balancer",
+ "name": "projectid",
"type": "string"
}
],
"type": "list"
},
{
- "description": "Region Id in which global load balancer is created",
- "name": "regionid",
- "type": "integer"
- },
- {
- "description": "the project name of the load balancer",
- "name": "project",
+ "description": "global load balancer rule ID",
+ "name": "id",
"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 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 domain of the load balancer rule",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "Load balancing method used for the global load balancer",
- "name": "gslblbmethod",
- "type": "string"
- },
- {
- "description": "DNS domain name given for the global load balancer",
- "name": "gslbdomainname",
- "type": "string"
- },
- {
- "description": "GSLB service type",
- "name": "gslbservicetype",
- "type": "string"
- },
- {
- "description": "name of the global load balancer rule",
- "name": "name",
- "type": "string"
- },
- {}
+ }
]
},
{
@@ -64915,10 +66025,10 @@
"type": "uuid"
},
{
- "description": "the account of the condition. Must be used with the domainId parameter.",
+ "description": "Relational Operator to be used with threshold.",
"length": 255,
- "name": "account",
- "required": false,
+ "name": "relationaloperator",
+ "required": true,
"type": "string"
},
{
@@ -64930,34 +66040,23 @@
"type": "uuid"
},
{
- "description": "Relational Operator to be used with threshold.",
+ "description": "the account of the condition. Must be used with the domainId parameter.",
"length": 255,
- "name": "relationaloperator",
- "required": true,
+ "name": "account",
+ "required": false,
"type": "string"
}
],
"related": "",
"response": [
{
- "description": "the owner of the Condition.",
- "name": "account",
- "type": "string"
- },
- {},
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the id of the Condition",
+ "name": "id",
"type": "string"
},
{
- "description": "Threshold Value for the counter.",
- "name": "threshold",
- "type": "long"
- },
- {
- "description": "the domain id of the Condition owner",
- "name": "domainid",
+ "description": "the project name of the Condition",
+ "name": "project",
"type": "string"
},
{
@@ -64966,13 +66065,19 @@
"type": "integer"
},
{
- "description": "the project name of the Condition",
- "name": "project",
- "type": "string"
+ "description": "Threshold Value for the counter.",
+ "name": "threshold",
+ "type": "long"
},
{
- "description": "the id of the Condition",
- "name": "id",
+ "description": "the domain name of the owner.",
+ "name": "domain",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the owner of the Condition.",
+ "name": "account",
"type": "string"
},
{
@@ -64980,11 +66085,6 @@
"name": "projectid",
"type": "string"
},
- {
- "description": "the domain name of the owner.",
- "name": "domain",
- "type": "string"
- },
{},
{
"description": "Details of the Counter.",
@@ -64992,13 +66092,23 @@
"type": "list"
},
{
+ "description": "Relational Operator to be used with threshold.",
+ "name": "relationaloperator",
+ "type": "string"
+ },
+ {
"description": "zone id of counter",
"name": "zoneid",
"type": "string"
},
{
- "description": "Relational Operator to be used with threshold.",
- "name": "relationaloperator",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the domain id of the Condition owner",
+ "name": "domainid",
"type": "string"
}
]
@@ -65009,27 +66119,6 @@
"name": "listProjects",
"params": [
{
- "description": "flag to display the resource icon for projects",
- "length": 255,
- "name": "showicon",
- "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 projects by name",
- "length": 255,
- "name": "name",
- "required": false,
- "type": "string"
- },
- {
"description": "List projects by username",
"length": 255,
"name": "username",
@@ -65037,6 +66126,20 @@
"type": "string"
},
{
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "List projects by tags (key/value pairs)",
+ "length": 255,
+ "name": "tags",
+ "required": false,
+ "type": "map"
+ },
+ {
"description": "list projects by project ID",
"length": 255,
"name": "id",
@@ -65047,11 +66150,18 @@
{
"description": "",
"length": 255,
- "name": "pagesize",
+ "name": "page",
"required": false,
"type": "integer"
},
{
+ "description": "list projects by name",
+ "length": 255,
+ "name": "name",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "list projects by state",
"length": 255,
"name": "state",
@@ -65059,11 +66169,11 @@
"type": "string"
},
{
- "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false",
+ "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",
@@ -65074,13 +66184,27 @@
"type": "uuid"
},
{
+ "description": "comma separated list of project details requested, value can be a list of [ all, resource, min]",
+ "length": 255,
+ "name": "details",
+ "required": false,
+ "type": "list"
+ },
+ {
"description": "",
"length": 255,
- "name": "page",
+ "name": "pagesize",
"required": false,
"type": "integer"
},
{
+ "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false",
+ "length": 255,
+ "name": "listall",
+ "required": false,
+ "type": "boolean"
+ },
+ {
"description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
"length": 255,
"name": "isrecursive",
@@ -65088,25 +66212,11 @@
"type": "boolean"
},
{
- "description": "List by keyword",
+ "description": "flag to display the resource icon for projects",
"length": 255,
- "name": "keyword",
+ "name": "showicon",
"required": false,
- "type": "string"
- },
- {
- "description": "comma separated list of project details requested, value can be a list of [ all, resource, min]",
- "length": 255,
- "name": "details",
- "required": false,
- "type": "list"
- },
- {
- "description": "List projects by tags (key/value pairs)",
- "length": 255,
- "name": "tags",
- "required": false,
- "type": "map"
+ "type": "boolean"
},
{
"description": "list projects by display text",
@@ -65119,74 +66229,8 @@
"related": "listProjectAccounts,activateProject,suspendProject,updateProject",
"response": [
{
- "description": "the total number of networks the project can own",
- "name": "networklimit",
- "type": "string"
- },
- {
- "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) owned by project",
- "name": "memorytotal",
- "type": "long"
- },
- {
- "description": "the total number of cpu cores owned by project",
- "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 allocated for this project",
- "name": "iptotal",
- "type": "long"
- },
- {
- "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 primary storage space (in GiB) the project can own",
- "name": "primarystoragelimit",
- "type": "string"
- },
- {
- "description": "the total primary storage space (in GiB) owned by project",
- "name": "primarystoragetotal",
- "type": "long"
- },
- {},
- {
- "description": "the total number of vpcs available to be created for this project",
- "name": "vpcavailable",
- "type": "string"
- },
- {
- "description": "the total number of virtual machines stopped for this project",
- "name": "vmstopped",
- "type": "integer"
- },
- {
- "description": "the total memory (in MB) available to be created for this project",
- "name": "memoryavailable",
+ "description": "the domain id the project belongs to",
+ "name": "domainid",
"type": "string"
},
{
@@ -65195,132 +66239,69 @@
"type": "string"
},
{
- "description": "the name of the project",
- "name": "name",
+ "description": "the id of the project",
+ "name": "id",
"type": "string"
},
{
- "description": "the total number of networks owned by project",
- "name": "networktotal",
+ "description": "the total number of public ip addresses allocated for this project",
+ "name": "iptotal",
"type": "long"
},
{
- "description": "the total number of cpu cores available to be created for this project",
- "name": "cpuavailable",
+ "description": "the total secondary storage space (in GiB) available to be used for this project",
+ "name": "secondarystorageavailable",
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "the total primary storage space (in GiB) the project can own",
+ "name": "primarystoragelimit",
+ "type": "string"
},
{
- "description": "the total volume being used by this project",
- "name": "volumetotal",
+ "description": "the total memory (in MB) available to be created for this project",
+ "name": "memoryavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total primary storage space (in GiB) owned by project",
+ "name": "primarystoragetotal",
"type": "long"
},
{
- "description": "the state of the project",
- "name": "state",
+ "description": "the total number of public ip addresses available for this project to acquire",
+ "name": "ipavailable",
"type": "string"
},
{
- "description": "the total number of templates available to be created by this project",
- "name": "templateavailable",
- "type": "string"
- },
- {
- "description": "the total secondary storage space (in GiB) owned by project",
- "name": "secondarystoragetotal",
- "type": "float"
- },
- {
- "description": "the total number of virtual machines available for this project to acquire",
- "name": "vmavailable",
- "type": "string"
+ "description": "the account name of the project's owners",
+ "name": "owner",
+ "type": "list"
},
{
"description": "the total volume available for this project",
"name": "volumeavailable",
"type": "string"
},
- {},
- {
- "description": "the domain name where the project belongs to",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the total number of virtual machines that can be deployed by this project",
- "name": "vmlimit",
- "type": "string"
- },
{
"description": "the total number of templates which can be created by this project",
"name": "templatelimit",
"type": "string"
},
{
- "description": "the total secondary storage space (in GiB) the project can own",
- "name": "secondarystoragelimit",
+ "description": "the total number of virtual machines available for this project to acquire",
+ "name": "vmavailable",
"type": "string"
},
{
- "description": "the list of resource tags associated with vm",
- "name": "tags",
- "response": [
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "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": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- }
- ],
- "type": "list"
+ "description": "the total number of templates available to be created by this project",
+ "name": "templateavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of networks owned by project",
+ "name": "networktotal",
+ "type": "long"
},
{
"description": "the project account name of the project",
@@ -65328,88 +66309,217 @@
"type": "string"
},
{
- "description": "the displaytext of the project",
- "name": "displaytext",
- "type": "string"
- },
- {
- "description": "the total memory (in MB) the project can own",
- "name": "memorylimit",
- "type": "string"
- },
- {
- "description": "the date this project was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the total secondary storage space (in GiB) available to be used for this project",
- "name": "secondarystorageavailable",
- "type": "string"
- },
- {
- "description": "the total number of snapshots which can be stored by this project",
- "name": "snapshotlimit",
- "type": "string"
- },
- {
- "description": "the id of the project",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the total number of public ip addresses this project can acquire",
- "name": "iplimit",
- "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 deployed by this project",
"name": "vmtotal",
"type": "long"
},
{
- "description": "the total number of vpcs owned by project",
- "name": "vpctotal",
+ "description": "the domain name where the project belongs to",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the list of resource tags associated with vm",
+ "name": "tags",
+ "response": [
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the 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": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ }
+ ],
+ "type": "list"
+ },
+ {
+ "description": "the name of the project",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the total volume being used by this project",
+ "name": "volumetotal",
"type": "long"
},
{
+ "description": "the date this project was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the displaytext of the project",
+ "name": "displaytext",
+ "type": "string"
+ },
+ {
+ "description": "the total secondary storage space (in GiB) owned by project",
+ "name": "secondarystoragetotal",
+ "type": "float"
+ },
+ {},
+ {
+ "description": "the total number of networks available to be created for this project",
+ "name": "networkavailable",
+ "type": "string"
+ },
+ {
"description": "the total number of vpcs the project can own",
"name": "vpclimit",
"type": "string"
},
{
- "description": "the total number of public ip addresses available for this project to acquire",
- "name": "ipavailable",
+ "description": "the total number of cpu cores available to be created for this project",
+ "name": "cpuavailable",
"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",
+ "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 UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the total memory (in MB) owned by project",
+ "name": "memorytotal",
+ "type": "long"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the total number of virtual machines running for this project",
+ "name": "vmrunning",
+ "type": "integer"
+ },
+ {
+ "description": "the total number of virtual machines stopped for this project",
+ "name": "vmstopped",
+ "type": "integer"
+ },
+ {
"description": "Base64 string representation of the resource icon",
"name": "icon",
"type": "resourceiconresponse"
},
{
- "description": "the total volume which can be used by this project",
- "name": "volumelimit",
- "type": "string"
- },
- {
"description": "the total number of snapshots stored by this project",
"name": "snapshottotal",
"type": "long"
},
{
- "description": "the total number of networks available to be created for this project",
- "name": "networkavailable",
+ "description": "the total primary storage space (in GiB) available to be used for this project",
+ "name": "primarystorageavailable",
"type": "string"
},
{
- "description": "the domain id the project belongs to",
- "name": "domainid",
+ "description": "the state of the project",
+ "name": "state",
+ "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": "the total number of snapshots which can be stored by this project",
+ "name": "snapshotlimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of cpu cores owned by project",
+ "name": "cputotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of networks the project can own",
+ "name": "networklimit",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the total secondary storage space (in GiB) the project can own",
+ "name": "secondarystoragelimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of virtual machines that can be deployed by this project",
+ "name": "vmlimit",
"type": "string"
}
],
@@ -65428,10 +66538,25 @@
"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": "details for account used to store specific parameters",
"length": 255,
- "name": "account",
+ "name": "accountdetails",
"required": false,
+ "type": "map"
+ },
+ {
+ "description": "Creates the account under the specified role.",
+ "length": 255,
+ "name": "roleid",
+ "related": "importRole,listRoles,updateRole",
+ "required": false,
+ "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.",
+ "length": 255,
+ "name": "password",
+ "required": true,
"type": "string"
},
{
@@ -65442,16 +66567,16 @@
"type": "string"
},
{
- "description": "details for account used to store specific parameters",
+ "description": "lastname",
"length": 255,
- "name": "accountdetails",
- "required": false,
- "type": "map"
+ "name": "lastname",
+ "required": true,
+ "type": "string"
},
{
- "description": "Clear text password (Default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.",
+ "description": "email",
"length": 255,
- "name": "password",
+ "name": "email",
"required": true,
"type": "string"
},
@@ -65463,21 +66588,6 @@
"type": "string"
},
{
- "description": "firstname",
- "length": 255,
- "name": "firstname",
- "required": true,
- "type": "string"
- },
- {
- "description": "Creates the account under the specified role.",
- "length": 255,
- "name": "roleid",
- "related": "importRole,listRoles,updateRole",
- "required": false,
- "type": "uuid"
- },
- {
"description": "Creates the user under the specified domain.",
"length": 255,
"name": "domainid",
@@ -65486,16 +66596,16 @@
"type": "uuid"
},
{
- "description": "lastname",
+ "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": "lastname",
- "required": true,
+ "name": "account",
+ "required": false,
"type": "string"
},
{
- "description": "Unique username.",
+ "description": "firstname",
"length": 255,
- "name": "username",
+ "name": "firstname",
"required": true,
"type": "string"
},
@@ -65514,9 +66624,9 @@
"type": "string"
},
{
- "description": "email",
+ "description": "Unique username.",
"length": 255,
- "name": "email",
+ "name": "username",
"required": true,
"type": "string"
}
@@ -65524,64 +66634,9 @@
"related": "enableAccount,listAccounts,listAccounts",
"response": [
{
- "description": "the state of the account",
- "name": "state",
- "type": "string"
- },
- {
- "description": "the total number of public ip addresses allocated for this account",
- "name": "iptotal",
- "type": "long"
- },
- {
- "description": "name of the Domain the account belongs to",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the total number of templates which have been created by this account",
- "name": "templatetotal",
- "type": "long"
- },
- {
- "description": "the total secondary storage space (in GiB) available to be used for this account",
- "name": "secondarystorageavailable",
- "type": "string"
- },
- {
- "description": "the total number of snapshots stored by this account",
- "name": "snapshottotal",
- "type": "long"
- },
- {
- "description": "the total volume being used by this account",
- "name": "volumetotal",
- "type": "long"
- },
- {
- "description": "the total number of public ip addresses this account can acquire",
- "name": "iplimit",
- "type": "string"
- },
- {
- "description": "the total number of cpu cores available to be created for this account",
- "name": "cpuavailable",
- "type": "string"
- },
- {
- "description": "the total number of public ip addresses available for this account to acquire",
- "name": "ipavailable",
- "type": "string"
- },
- {
- "description": "the default zone of the account",
- "name": "defaultzoneid",
- "type": "string"
- },
- {
- "description": "the total number of virtual machines available for this account to acquire",
- "name": "vmavailable",
- "type": "string"
+ "description": "details for the account",
+ "name": "accountdetails",
+ "type": "map"
},
{
"description": "account type (admin, domain-admin, user)",
@@ -65589,163 +66644,24 @@
"type": "short"
},
{
- "description": "the total number of network traffic bytes sent",
- "name": "sentbytes",
- "type": "long"
- },
- {
- "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)",
- "name": "roletype",
- "type": "string"
- },
- {
- "description": "the total memory (in MB) owned by account",
- "name": "memorytotal",
- "type": "long"
- },
- {
- "description": "the id of the account",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the total number of templates available to be created by this account",
- "name": "templateavailable",
- "type": "string"
- },
- {
- "description": "the ID of the role",
- "name": "roleid",
- "type": "string"
- },
- {
- "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",
- "type": "string"
- },
- {
"description": "the total number of cpu cores the account can own",
"name": "cpulimit",
"type": "string"
},
{
- "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 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",
- "type": "integer"
- },
- {
- "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",
- "type": "string"
- },
- {
- "description": "the total memory (in MB) the account can own",
- "name": "memorylimit",
- "type": "string"
- },
- {
- "description": "the total secondary storage space (in GiB) owned by account",
- "name": "secondarystoragetotal",
- "type": "float"
- },
- {
- "description": "the total memory (in MB) available to be created for this account",
- "name": "memoryavailable",
- "type": "string"
- },
- {
- "description": "the network domain",
- "name": "networkdomain",
- "type": "string"
- },
- {
- "description": "the total number of virtual machines that can be deployed by this account",
- "name": "vmlimit",
- "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": "the total number of virtual machines stopped for this account",
- "name": "vmstopped",
- "type": "integer"
- },
- {
- "description": "the name of the account",
- "name": "name",
+ "description": "the total memory (in MB) available to be created for this account",
+ "name": "memoryavailable",
"type": "string"
},
+ {},
{
- "description": "the total number of projects the account can own",
- "name": "projectlimit",
- "type": "string"
- },
- {
- "description": "the total number of templates which can be created by this account",
- "name": "templatelimit",
- "type": "string"
- },
- {
- "description": "true if the account requires cleanup",
- "name": "iscleanuprequired",
- "type": "boolean"
- },
- {
- "description": "the 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 total primary storage space (in GiB) the account can own",
- "name": "primarystoragelimit",
- "type": "string"
- },
- {
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
- },
- {
- "description": "the total number of virtual machines deployed by this account",
- "name": "vmtotal",
+ "description": "the total memory (in MB) owned by account",
+ "name": "memorytotal",
"type": "long"
},
{
@@ -65754,13 +66670,103 @@
"type": "list"
},
{
+ "description": "the name of the account",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "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",
"type": "long"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the total number of public ip addresses available for this account to acquire",
+ "name": "ipavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total memory (in MB) the account can own",
+ "name": "memorylimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of snapshots stored by this account",
+ "name": "snapshottotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of snapshots available for this account",
+ "name": "snapshotavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of networks available to be created for this account",
+ "name": "networkavailable",
+ "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 network traffic bytes sent",
+ "name": "sentbytes",
+ "type": "long"
+ },
+ {
+ "description": "the total number of cpu cores owned by account",
+ "name": "cputotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of templates which can be created by this account",
+ "name": "templatelimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of cpu cores available to be created for this account",
+ "name": "cpuavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of projects the account can own",
+ "name": "projectlimit",
+ "type": "string"
+ },
+ {
+ "description": "the total volume available for this account",
+ "name": "volumeavailable",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the role",
+ "name": "roleid",
+ "type": "string"
+ },
+ {
+ "description": "the default zone of the account",
+ "name": "defaultzoneid",
+ "type": "string"
+ },
+ {
+ "description": "the total number of templates which have been created by this account",
+ "name": "templatetotal",
+ "type": "long"
+ },
+ {
+ "description": "the total primary storage space (in GiB) available to be used for this account",
+ "name": "primarystorageavailable",
"type": "string"
},
{
@@ -65769,13 +66775,23 @@
"type": "boolean"
},
{
- "description": "the total secondary storage space (in GiB) the account can own",
- "name": "secondarystoragelimit",
+ "description": "path of the Domain the account belongs to",
+ "name": "domainpath",
"type": "string"
},
{
- "description": "the total number of projects available for administration by this account",
- "name": "projectavailable",
+ "description": "the date when this account was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the total number of networks the account can own",
+ "name": "networklimit",
"type": "string"
},
{
@@ -65784,102 +66800,158 @@
"type": "string"
},
{
+ "description": "the total primary storage space (in GiB) owned by account",
+ "name": "primarystoragetotal",
+ "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 secondary storage space (in GiB) owned by account",
+ "name": "secondarystoragetotal",
+ "type": "float"
+ },
+ {
+ "description": "the total volume which can be used by this account",
+ "name": "volumelimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of vpcs owned by account",
+ "name": "vpctotal",
+ "type": "long"
+ },
+ {
+ "description": "the total secondary storage space (in GiB) available to be used for this account",
+ "name": "secondarystorageavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of vpcs the account can own",
+ "name": "vpclimit",
+ "type": "string"
+ },
+ {
+ "description": "name of the Domain the account belongs to",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the total number of virtual machines deployed by this account",
+ "name": "vmtotal",
+ "type": "long"
+ },
+ {
+ "description": "true if the account requires cleanup",
+ "name": "iscleanuprequired",
+ "type": "boolean"
+ },
+ {
+ "description": "the total number of virtual machines stopped for this account",
+ "name": "vmstopped",
+ "type": "integer"
+ },
+ {
+ "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",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the total number of projects being administrated by this account",
+ "name": "projecttotal",
+ "type": "long"
+ },
+ {
"description": "the list of users associated with account",
"name": "user",
"response": [
{
- "description": "the account type of the user",
- "name": "accounttype",
- "type": "short"
- },
- {
- "description": "the user name",
- "name": "username",
- "type": "string"
- },
- {
- "description": "the account name of the user",
- "name": "account",
- "type": "string"
- },
- {
"description": "the user email address",
"name": "email",
"type": "string"
},
{
- "description": "the date and time the user account was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the ID of the role",
- "name": "roleid",
- "type": "string"
- },
- {
- "description": "the name of the role",
- "name": "rolename",
- "type": "string"
- },
- {
- "description": "the secret key of the user",
- "name": "secretkey",
- "type": "string"
- },
- {
- "description": "the source type of the user in lowercase, such as native, ldap, saml2",
- "name": "usersource",
- "type": "string"
- },
- {
- "description": "the user firstname",
- "name": "firstname",
- "type": "string"
- },
- {
- "description": "the user lastname",
- "name": "lastname",
- "type": "string"
- },
- {
- "description": "the domain name of the user",
- "name": "domain",
- "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 timezone user was created in",
- "name": "timezone",
- "type": "string"
- },
- {
"description": "the api key of the user",
"name": "apikey",
"type": "string"
},
{
+ "description": "the date and time the user account was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the user firstname",
+ "name": "firstname",
+ "type": "string"
+ },
+ {
+ "description": "the user name",
+ "name": "username",
+ "type": "string"
+ },
+ {
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "description": "the user ID",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the user lastname",
+ "name": "lastname",
+ "type": "string"
+ },
+ {
+ "description": "the user state",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "the timezone user was created in",
+ "name": "timezone",
+ "type": "string"
+ },
+ {
"description": "true if user is default, false otherwise",
"name": "isdefault",
"type": "boolean"
},
{
+ "description": "the account name of the user",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the role",
+ "name": "roleid",
+ "type": "string"
+ },
+ {
"description": "the account ID of the user",
"name": "accountid",
"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"
},
{
@@ -65888,59 +66960,97 @@
"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 domain name of the user",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the account type of the user",
+ "name": "accounttype",
+ "type": "short"
+ },
+ {
"description": "the type of the role",
"name": "roletype",
"type": "string"
},
{
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
+ "description": "the name of the role",
+ "name": "rolename",
+ "type": "string"
}
],
"type": "list"
},
- {},
{
- "description": "the total number of networks the account can own",
- "name": "networklimit",
+ "description": "the total number of public ip addresses this account can acquire",
+ "name": "iplimit",
"type": "string"
},
{
- "description": "the total volume which can be used by this account",
- "name": "volumelimit",
+ "description": "the total number of templates available to be created by this account",
+ "name": "templateavailable",
"type": "string"
},
{
+ "description": "id of the Domain the account belongs to",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the total number of snapshots which can be stored by this account",
+ "name": "snapshotlimit",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
"description": "the total number of vpcs available to be created for this account",
"name": "vpcavailable",
"type": "string"
},
{
- "description": "the total number of cpu cores owned by account",
- "name": "cputotal",
- "type": "long"
- },
- {
- "description": "the total number of vpcs the account can own",
- "name": "vpclimit",
- "type": "string"
- },
- {},
- {
- "description": "id of the Domain the account belongs to",
- "name": "domainid",
+ "description": "the state of the account",
+ "name": "state",
"type": "string"
},
{
- "description": "details for the account",
- "name": "accountdetails",
- "type": "map"
+ "description": "the network domain",
+ "name": "networkdomain",
+ "type": "string"
},
{
- "description": "the total number of projects being administrated by this account",
- "name": "projecttotal",
+ "description": "the id of the account",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the total number of public ip addresses allocated for this account",
+ "name": "iptotal",
"type": "long"
+ },
+ {
+ "description": "the total secondary storage space (in GiB) the account can own",
+ "name": "secondarystoragelimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of virtual machines that can be deployed by this account",
+ "name": "vmlimit",
+ "type": "string"
}
]
},
@@ -65961,59 +67071,136 @@
"related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance",
"response": [
{
- "description": "Guest vm Boot Mode",
- "name": "bootmode",
+ "description": "the ID of the host for the virtual machine",
+ "name": "hostid",
"type": "string"
},
{
- "description": "the total number of network traffic bytes sent",
- "name": "sentbytes",
+ "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 project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "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": "tag key name",
+ "name": "key",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the pool type of the virtual machine",
+ "name": "pooltype",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the service offering of the virtual machine",
+ "name": "serviceofferingid",
+ "type": "string"
+ },
+ {
+ "description": "the target memory in vm",
+ "name": "memorytargetkbs",
"type": "long"
},
{
+ "description": "the total number of network traffic bytes received",
+ "name": "receivedbytes",
+ "type": "long"
+ },
+ {
+ "description": "the user's name who deployed the virtual machine",
+ "name": "username",
+ "type": "string"
+ },
+ {
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "description": "the write (io) of disk on the vm",
+ "name": "diskiowrite",
+ "type": "long"
+ },
+ {
+ "description": "the project id of the vm",
+ "name": "projectid",
+ "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 security groups associated with the virtual machine",
"name": "securitygroup",
"response": [
{
- "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 list of virtualmachine ids associated with this securitygroup",
- "name": "virtualmachineids",
- "type": "set"
- },
- {
- "description": "the description of the security group",
- "name": "description",
- "type": "string"
- },
- {
"description": "the list of egress rules associated with the security group",
"name": "egressrule",
"response": [
{
- "description": "the 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 protocol of the security group rule",
"name": "protocol",
"type": "string"
@@ -66029,8 +67216,8 @@
"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"
},
{
@@ -66039,9 +67226,9 @@
"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",
@@ -66053,8 +67240,8 @@
"type": "string"
},
{
- "description": "the project name where tag belongs to",
- "name": "project",
+ "description": "the domain associated with the tag",
+ "name": "domain",
"type": "string"
},
{
@@ -66063,18 +67250,28 @@
"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 domain associated with the tag",
- "name": "domain",
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
"type": "string"
},
{
- "description": "the account associated with the tag",
- "name": "account",
+ "description": "the project name where tag belongs to",
+ "name": "project",
"type": "string"
},
{
@@ -66086,39 +67283,19 @@
"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"
}
],
"type": "set"
+ },
+ {
+ "description": "the ending IP of the security group rule ",
+ "name": "endport",
+ "type": "integer"
}
],
"type": "set"
},
{
- "description": "the domain ID of the security group",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the project name of the group",
- "name": "project",
- "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": [
@@ -66128,13 +67305,28 @@
"type": "string"
},
{
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
"description": "customer associated with the tag",
"name": "customer",
"type": "string"
},
{
- "description": "the domain associated with the tag",
- "name": "domain",
+ "description": "tag key name",
+ "name": "key",
"type": "string"
},
{
@@ -66148,120 +67340,80 @@
"type": "string"
},
{
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
"description": "the ID of the domain associated with the tag",
"name": "domainid",
"type": "string"
},
{
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
"type": "string"
}
],
"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 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": "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",
- "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",
- "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": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
"description": "the domain associated with the tag",
"name": "domain",
"type": "string"
},
{
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
"description": "customer associated with the tag",
"name": "customer",
"type": "string"
},
{
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "the 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 project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
}
],
"type": "set"
@@ -66272,14 +67424,14 @@
"type": "string"
},
{
- "description": "the starting IP of the security group rule",
- "name": "startport",
- "type": "integer"
+ "description": "the protocol of the security group rule",
+ "name": "protocol",
+ "type": "string"
},
{
- "description": "security group name",
- "name": "securitygroupname",
- "type": "string"
+ "description": "the 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",
@@ -66287,131 +67439,84 @@
"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",
+ "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 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"
+ },
+ {
+ "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 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",
+ "type": "string"
+ },
+ {
+ "description": "the name of the security group",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the description of the security group",
+ "name": "description",
+ "type": "string"
}
],
"type": "set"
},
{
- "description": "the ID of the virtual machine",
- "name": "id",
- "type": "string"
- },
- {},
- {
- "description": "the ID of the host for the virtual machine",
- "name": "hostid",
- "type": "string"
- },
- {
- "description": "the name of the ISO attached to the virtual machine",
- "name": "isoname",
- "type": "string"
- },
- {
- "description": "the memory used by the vm",
- "name": "memorykbs",
- "type": "long"
- },
- {
- "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": "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 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 pool type of the virtual machine",
- "name": "pooltype",
- "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 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",
- "type": "string"
- },
- {
- "description": "the state of the virtual machine",
- "name": "state",
- "type": "string"
- },
- {
- "description": "the amount of the vm's CPU currently used",
- "name": "cpuused",
- "type": "string"
- },
- {
- "description": "the virtual network for the service offering",
- "name": "forvirtualnetwork",
- "type": "boolean"
- },
- {
- "description": "the incoming network traffic on the vm",
- "name": "networkkbsread",
- "type": "long"
- },
- {
- "description": "the name of the domain in which the virtual machine exists",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the speed of each cpu",
- "name": "cpuspeed",
- "type": "integer"
- },
- {
- "description": "user generated name. The name of the virtual machine is returned if no displayname exists.",
- "name": "displayname",
+ "description": "the ID of the backup offering of the virtual machine",
+ "name": "backupofferingid",
"type": "string"
},
{
@@ -66420,223 +67525,6 @@
"type": "string"
},
{
- "description": "the user's name who deployed the virtual machine",
- "name": "username",
- "type": "string"
- },
- {
- "description": "OS name of the vm",
- "name": "osdisplayname",
- "type": "string"
- },
- {
- "description": "the account associated with the virtual machine",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the name of the disk offering of the virtual machine",
- "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 outgoing network traffic on the host",
- "name": "networkkbswrite",
- "type": "long"
- },
- {
- "description": "the project name of the vm",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the password (if exists) of the virtual machine",
- "name": "password",
- "type": "string"
- },
- {
- "description": "the name of the template for the virtual machine",
- "name": "templatename",
- "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 ID of the nic",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the type of the nic",
- "name": "type",
- "type": "string"
- },
- {
- "description": "the extra dhcp options on the nic",
- "name": "extradhcpoption",
- "type": "list"
- },
- {
- "description": "the gateway of IPv6 network",
- "name": "ip6gateway",
- "type": "string"
- },
- {
- "description": "Type of adapter if available",
- "name": "adaptertype",
- "type": "string"
- },
- {
- "description": "true if nic is default, false otherwise",
- "name": "macaddress",
- "type": "string"
- },
- {
- "description": "Id of the vm to which the nic belongs",
- "name": "virtualmachineid",
- "type": "string"
- },
- {
- "description": "the name of the corresponding network",
- "name": "networkname",
- "type": "string"
- },
- {
- "description": "ID of the VLAN/VNI if available",
- "name": "vlanid",
- "type": "integer"
- },
- {
- "description": "the ip address of the nic",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "description": "the isolation uri of the nic",
- "name": "isolationuri",
- "type": "string"
- },
- {
- "description": "the isolated private VLAN if available",
- "name": "isolatedpvlan",
- "type": "integer"
- },
- {
- "description": "Id of the NSX Logical Switch (if NSX based), null otherwise",
- "name": "nsxlogicalswitch",
- "type": "string"
- },
- {
- "description": "true if nic is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
- },
- {
- "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise",
- "name": "nsxlogicalswitchport",
- "type": "string"
- },
- {
- "description": "the traffic type of the nic",
- "name": "traffictype",
- "type": "string"
- },
- {
- "description": "the IPv6 address of network",
- "name": "ip6address",
- "type": "string"
- },
- {
- "description": "the gateway of the nic",
- "name": "gateway",
- "type": "string"
- },
- {
- "description": "the isolated private VLAN type if available",
- "name": "isolatedpvlantype",
- "type": "string"
- },
- {
- "description": "IP addresses associated with NIC found for unmanaged VM",
- "name": "ipaddresses",
- "type": "list"
- },
- {
- "description": "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 Secondary ipv4 addr of nic",
- "name": "secondaryip",
- "type": "list"
- },
- {
- "description": "the ID of the corresponding network",
- "name": "networkid",
- "type": "string"
- },
- {
- "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 number of cpu this virtual machine is running with",
- "name": "cpunumber",
- "type": "integer"
- },
- {
- "description": "the ID of the availablility zone for the virtual machine",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the write (io) of disk on the vm",
- "name": "diskiowrite",
- "type": "long"
- },
- {
- "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": "true if high-availability is enabled, false otherwise",
"name": "haenable",
"type": "boolean"
@@ -66647,21 +67535,398 @@
"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": "publicipid",
"type": "string"
},
+ {},
+ {
+ "description": "the name of the virtual machine",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the read (bytes) of disk on the vm",
+ "name": "diskkbsread",
+ "type": "long"
+ },
+ {
+ "description": "the name of the template for the virtual machine",
+ "name": "templatename",
+ "type": "string"
+ },
+ {
+ "description": "instance name of the user vm; this parameter is returned to the ROOT admin only",
+ "name": "instancename",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the virtual machine",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the user's ID who deployed the virtual machine",
+ "name": "userid",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the ISO attached to the virtual machine",
+ "name": "isoname",
+ "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": "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 memory allocated for the virtual machine",
"name": "memory",
"type": "integer"
},
{
+ "description": "the incoming network traffic on the vm",
+ "name": "networkkbsread",
+ "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 virtual network for the service offering",
+ "name": "forvirtualnetwork",
+ "type": "boolean"
+ },
+ {
+ "description": "the ID of the availablility zone for the virtual machine",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "Os type ID of the virtual machine",
+ "name": "guestosid",
+ "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": "OS type id of the vm",
+ "name": "ostypeid",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the virtual machine",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "an alternate display text of the ISO attached to the virtual machine",
+ "name": "isodisplaytext",
+ "type": "string"
+ },
+ {
+ "description": "OS name of the vm",
+ "name": "osdisplayname",
+ "type": "string"
+ },
+ {
+ "description": "device type of the root volume",
+ "name": "rootdevicetype",
+ "type": "string"
+ },
+ {
+ "description": "the list of nics associated with vm",
+ "name": "nic",
+ "response": [
+ {
+ "description": "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 ID of the nic",
+ "name": "id",
+ "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 ip address of the nic",
+ "name": "ipaddress",
+ "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 type of the nic",
+ "name": "type",
+ "type": "string"
+ },
+ {
+ "description": "the extra dhcp options on the nic",
+ "name": "extradhcpoption",
+ "type": "list"
+ },
+ {
+ "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise",
+ "name": "nsxlogicalswitchport",
+ "type": "string"
+ },
+ {
+ "description": "the netmask of the nic",
+ "name": "netmask",
+ "type": "string"
+ },
+ {
+ "description": "the cidr of IPv6 network",
+ "name": "ip6cidr",
+ "type": "string"
+ },
+ {
+ "description": "the isolated private VLAN if available",
+ "name": "isolatedpvlan",
+ "type": "integer"
+ },
+ {
+ "description": "Type of adapter if available",
+ "name": "adaptertype",
+ "type": "string"
+ },
+ {
+ "description": "the gateway of IPv6 network",
+ "name": "ip6gateway",
+ "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": "device id for the network when plugged into the virtual machine",
+ "name": "deviceid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the corresponding network",
+ "name": "networkname",
+ "type": "string"
+ },
+ {
+ "description": "the broadcast uri of the nic",
+ "name": "broadcasturi",
+ "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": "the isolated private VLAN type if available",
+ "name": "isolatedpvlantype",
+ "type": "string"
+ },
+ {
+ "description": "the IPv6 address of network",
+ "name": "ip6address",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "List of read-only Vm details as comma separated string.",
+ "name": "readonlydetails",
+ "type": "string"
+ },
+ {
+ "description": "the write (bytes) of disk on the vm",
+ "name": "diskkbswrite",
+ "type": "long"
+ },
+ {
+ "description": "Vm details in key/value pairs.",
+ "name": "details",
+ "type": "map"
+ },
+ {
+ "description": "the group ID of the virtual machine",
+ "name": "groupid",
+ "type": "string"
+ },
+ {
+ "description": "user generated name. The name of the virtual machine is returned if no displayname exists.",
+ "name": "displayname",
+ "type": "string"
+ },
+ {
+ "description": "State of the Service from LB rule",
+ "name": "servicestate",
+ "type": "string"
+ },
+ {
+ "description": "the total number of network traffic bytes sent",
+ "name": "sentbytes",
+ "type": "long"
+ },
+ {
+ "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 speed of each cpu",
+ "name": "cpuspeed",
+ "type": "integer"
+ },
+ {
+ "description": "list of affinity groups associated with the virtual machine",
+ "name": "affinitygroup",
+ "response": [
+ {
+ "description": "the name of the affinity group",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the description of the affinity group",
+ "name": "description",
+ "type": "string"
+ },
+ {
+ "description": "the account owning the affinity group",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the project ID of the affinity group",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the type of the affinity group",
+ "name": "type",
+ "type": "string"
+ },
+ {
+ "description": "the domain name of the affinity group",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "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 ID of the affinity group",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the affinity group",
+ "name": "project",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {},
+ {
+ "description": "public IP address id associated with vm via Static nat rule",
+ "name": "publicip",
+ "type": "string"
+ },
+ {
+ "description": "the password (if exists) of the virtual machine",
+ "name": "password",
+ "type": "string"
+ },
+ {
+ "description": "the hypervisor on which the template runs",
+ "name": "hypervisor",
+ "type": "string"
+ },
+ {
"description": "an optional field whether to the display the vm to the end user or not.",
"name": "displayvm",
"type": "boolean"
@@ -66677,171 +67942,18 @@
"type": "string"
},
{
- "description": "the internal memory that's free in vm or zero if it can not be calculated",
- "name": "memoryintfreekbs",
- "type": "long"
- },
- {
- "description": "the group name of the virtual machine",
- "name": "group",
+ "description": "the ID of the domain in which the virtual machine exists",
+ "name": "domainid",
"type": "string"
},
{
- "description": "Vm details in key/value pairs.",
- "name": "details",
- "type": "map"
- },
- {
- "description": "the group ID of the virtual machine",
- "name": "groupid",
+ "description": "the project name of the vm",
+ "name": "project",
"type": "string"
},
{
- "description": "the total number of network traffic bytes received",
- "name": "receivedbytes",
- "type": "long"
- },
- {
- "description": "public IP address id associated with vm via Static nat rule",
- "name": "publicipid",
- "type": "string"
- },
- {
- "description": "the date when this virtual machine was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the read (bytes) of disk on the vm",
- "name": "diskkbsread",
- "type": "long"
- },
- {
- "description": "State of the Service from LB rule",
- "name": "servicestate",
- "type": "string"
- },
- {
- "description": "Os type ID of the virtual machine",
- "name": "guestosid",
- "type": "string"
- },
- {
- "description": "the write (bytes) of disk on the vm",
- "name": "diskkbswrite",
- "type": "long"
- },
- {
- "description": "the user's ID who deployed the virtual machine",
- "name": "userid",
- "type": "string"
- },
- {
- "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": "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 account owning the affinity group",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the domain name of the affinity group",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the project ID of the affinity group",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the domain ID of the affinity group",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the type of the affinity group",
- "name": "type",
- "type": "string"
- },
- {
- "description": "the description of the affinity group",
- "name": "description",
- "type": "string"
- },
- {
- "description": "the 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 ID of the backup offering of the virtual machine",
- "name": "backupofferingid",
- "type": "string"
- },
- {
- "description": "public IP address id associated with vm via Static nat rule",
- "name": "publicip",
- "type": "string"
- },
- {
- "description": "the name of the service offering of the virtual machine",
- "name": "serviceofferingname",
- "type": "string"
- },
- {
- "description": "device ID of the root volume",
- "name": "rootdeviceid",
- "type": "long"
- },
- {
- "description": "the target memory in vm",
- "name": "memorytargetkbs",
- "type": "long"
- },
- {
- "description": "Guest vm Boot Type",
- "name": "boottype",
- "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",
+ "description": "the 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"
},
{
@@ -66850,66 +67962,64 @@
"type": "string"
},
{
- "description": "instance name of the user vm; this parameter is returned to the ROOT admin only",
- "name": "instancename",
+ "description": "the date when this virtual machine was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the number of cpu this virtual machine is running with",
+ "name": "cpunumber",
+ "type": "integer"
+ },
+ {
+ "description": "the memory used by the vm",
+ "name": "memorykbs",
+ "type": "long"
+ },
+ {
+ "description": "the vgpu type used by the virtual machine",
+ "name": "vgpu",
"type": "string"
},
{
- "description": "the list of resource tags associated",
- "name": "tags",
- "response": [
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "the 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 project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- }
- ],
- "type": "set"
+ "description": "the group name of the virtual machine",
+ "name": "group",
+ "type": "string"
+ },
+ {
+ "description": "the name of the disk offering of the virtual machine",
+ "name": "diskofferingname",
+ "type": "string"
+ },
+ {
+ "description": "the internal memory that's free in vm or zero if it can not be calculated",
+ "name": "memoryintfreekbs",
+ "type": "long"
+ },
+ {
+ "description": "Guest vm Boot Mode",
+ "name": "bootmode",
+ "type": "string"
+ },
+ {
+ "description": "the outgoing network traffic on the host",
+ "name": "networkkbswrite",
+ "type": "long"
+ },
+ {
+ "description": "the name of the backup offering of the virtual machine",
+ "name": "backupofferingname",
+ "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"
}
],
"since": "4.2.0"
@@ -66920,13 +68030,6 @@
"name": "listHostTags",
"params": [
{
- "description": "",
- "length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
- },
- {
"description": "List by keyword",
"length": 255,
"name": "keyword",
@@ -66939,13 +68042,20 @@
"name": "pagesize",
"required": false,
"type": "integer"
+ },
+ {
+ "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 name of the host tag",
+ "name": "name",
"type": "string"
},
{
@@ -66953,6 +68063,12 @@
"name": "jobstatus",
"type": "integer"
},
+ {},
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
{
"description": "the host ID of the host tag",
"name": "hostid",
@@ -66963,12 +68079,6 @@
"name": "id",
"type": "string"
},
- {
- "description": "the name of the host tag",
- "name": "name",
- "type": "string"
- },
- {},
{}
]
},
@@ -66978,10 +68088,10 @@
"name": "addGuestOs",
"params": [
{
- "description": "Optional name for Guest OS",
+ "description": "Unique display name for Guest OS",
"length": 255,
- "name": "name",
- "required": false,
+ "name": "osdisplayname",
+ "required": true,
"type": "string"
},
{
@@ -66992,10 +68102,10 @@
"type": "map"
},
{
- "description": "Unique display name for Guest OS",
+ "description": "Optional name for Guest OS",
"length": 255,
- "name": "osdisplayname",
- "required": true,
+ "name": "name",
+ "required": false,
"type": "string"
},
{
@@ -67009,12 +68119,18 @@
],
"related": "",
"response": [
+ {
+ "description": "the ID of the OS category",
+ "name": "oscategoryid",
+ "type": "string"
+ },
{},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
},
+ {},
{
"description": "the ID of the OS type",
"name": "id",
@@ -67025,21 +68141,15 @@
"name": "description",
"type": "string"
},
- {},
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the ID of the OS category",
- "name": "oscategoryid",
- "type": "string"
- },
{
"description": "is the guest OS user defined",
"name": "isuserdefined",
"type": "boolean"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
}
],
"since": "4.4.0"
@@ -67050,21 +68160,6 @@
"name": "addAnnotation",
"params": [
{
- "description": "the annotation is visible for admins only",
- "length": 255,
- "name": "adminsonly",
- "required": false,
- "since": "4.16.0",
- "type": "boolean"
- },
- {
- "description": "the entity type (only HOST is allowed atm)",
- "length": 255,
- "name": "entitytype",
- "required": false,
- "type": "string"
- },
- {
"description": "the id of the entity to annotate",
"length": 255,
"name": "entityid",
@@ -67077,29 +68172,39 @@
"name": "annotation",
"required": false,
"type": "string"
+ },
+ {
+ "description": "the entity type (only HOST is allowed atm)",
+ "length": 255,
+ "name": "entitytype",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the annotation is visible for admins only",
+ "length": 255,
+ "name": "adminsonly",
+ "required": false,
+ "since": "4.16.0",
+ "type": "boolean"
}
],
"related": "removeAnnotation,updateAnnotationVisibility",
"response": [
{
- "description": "True if the annotation is available for admins only",
- "name": "adminsonly",
- "type": "boolean"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the (uu)id of the annotation",
+ "name": "id",
"type": "string"
},
{
- "description": "the name of the entitiy to which this annotation pertains",
- "name": "entityname",
+ "description": "The username of the user that entered the annotation",
+ "name": "username",
"type": "string"
},
{
- "description": "the contents of the annotation",
- "name": "annotation",
- "type": "string"
+ "description": "the creation timestamp for this annotation",
+ "name": "created",
+ "type": "date"
},
{
"description": "the removal timestamp for this annotation",
@@ -67111,21 +68216,19 @@
"name": "userid",
"type": "string"
},
- {},
- {},
{
"description": "the (uu)id of the entitiy to which this annotation pertains",
"name": "entityid",
"type": "string"
},
{
- "description": "The username of the user that entered the annotation",
- "name": "username",
- "type": "string"
+ "description": "True if the annotation is available for admins only",
+ "name": "adminsonly",
+ "type": "boolean"
},
{
- "description": "the type of the annotated entity",
- "name": "entitytype",
+ "description": "the contents of the annotation",
+ "name": "annotation",
"type": "string"
},
{
@@ -67133,15 +68236,22 @@
"name": "jobstatus",
"type": "integer"
},
+ {},
+ {},
{
- "description": "the (uu)id of the annotation",
- "name": "id",
+ "description": "the type of the annotated entity",
+ "name": "entitytype",
"type": "string"
},
{
- "description": "the creation timestamp for this annotation",
- "name": "created",
- "type": "date"
+ "description": "the name of the entitiy to which this annotation pertains",
+ "name": "entityname",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
}
],
"since": "4.11"
@@ -67161,27 +68271,27 @@
}
],
"response": [
+ {},
+ {},
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
- {},
{
- "description": "true if operation is executed successfully",
- "name": "success",
- "type": "boolean"
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
},
{
"description": "any text associated with the success or failure",
"name": "displaytext",
"type": "string"
},
- {},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
+ "description": "true if operation is executed successfully",
+ "name": "success",
+ "type": "boolean"
}
],
"since": "4.4.0"
@@ -67192,6 +68302,78 @@
"name": "registerIso",
"params": [
{
+ "description": "the checksum value of this ISO. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{<algorithm>}\", not including the double quotes. In this <algorithm> is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.",
+ "length": 255,
+ "name": "checksum",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed",
+ "length": 255,
+ "name": "ostypeid",
+ "related": "",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "the display text of the ISO. This is usually used for display purposes.",
+ "length": 4096,
+ "name": "displaytext",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "Register ISO for the project",
+ "length": 255,
+ "name": "projectid",
+ "related": "listProjectAccounts,activateProject,suspendProject,updateProject",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "an optional account name. Must be used with domainId.",
+ "length": 255,
+ "name": "account",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "true if password reset feature is supported; default is false",
+ "length": 255,
+ "name": "passwordenabled",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "true if ISO contains XS/VMWare tools inorder to support dynamic scaling of VM CPU/memory",
+ "length": 255,
+ "name": "isdynamicallyscalable",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "Image store UUID",
+ "length": 255,
+ "name": "imagestoreuuid",
+ "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 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 this ISO is bootable. If not passed explicitly its assumed to be true",
"length": 255,
"name": "bootable",
@@ -67199,6 +68381,36 @@
"type": "boolean"
},
{
+ "description": "the ID of the zone you wish to register the ISO to.",
+ "length": 255,
+ "name": "zoneid",
+ "related": "createZone,updateZone,listZones,listZones",
+ "required": true,
+ "type": "uuid"
+ },
+ {
+ "description": "the name of the ISO",
+ "length": 255,
+ "name": "name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "true if the ISO or its derivatives are extractable; default is false",
+ "length": 255,
+ "name": "isextractable",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "an optional domainId. If the account parameter is used, domainId must also be used.",
+ "length": 255,
+ "name": "domainid",
+ "related": "listDomainChildren,listDomains",
+ "required": false,
+ "type": "uuid"
+ },
+ {
"description": "true if ISO should bypass Secondary Storage and be downloaded to Primary Storage on deployment",
"length": 255,
"name": "directdownload",
@@ -67211,369 +68423,120 @@
"name": "isfeatured",
"required": false,
"type": "boolean"
- },
- {
- "description": "Image store UUID",
- "length": 255,
- "name": "imagestoreuuid",
- "required": false,
- "type": "string"
- },
- {
- "description": "the name of the ISO",
- "length": 255,
- "name": "name",
- "required": true,
- "type": "string"
- },
- {
- "description": "an optional account name. Must be used with domainId.",
- "length": 255,
- "name": "account",
- "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": "ispublic",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "the ID of the zone you wish to register the ISO to.",
- "length": 255,
- "name": "zoneid",
- "related": "createZone,updateZone,listZones,listZones",
- "required": true,
- "type": "uuid"
- },
- {
- "description": "Register ISO for the project",
- "length": 255,
- "name": "projectid",
- "related": "listProjectAccounts,activateProject,suspendProject,updateProject",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "the display text of the ISO. This is usually used for display purposes.",
- "length": 4096,
- "name": "displaytext",
- "required": true,
- "type": "string"
- },
- {
- "description": "true if password reset feature is supported; default is false",
- "length": 255,
- "name": "passwordenabled",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "true if the ISO or its derivatives are extractable; default is false",
- "length": 255,
- "name": "isextractable",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "the ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed",
- "length": 255,
- "name": "ostypeid",
- "related": "",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "an optional domainId. If the account parameter is used, domainId must also be used.",
- "length": 255,
- "name": "domainid",
- "related": "listDomainChildren,listDomains",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "true if ISO contains XS/VMWare tools inorder to support dynamic scaling of VM CPU/memory",
- "length": 255,
- "name": "isdynamicallyscalable",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "the URL to where the ISO is currently being hosted",
- "length": 2048,
- "name": "url",
- "required": true,
- "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 \"{<algorithm>}\", not including the double quotes. In this <algorithm> is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.",
- "length": 255,
- "name": "checksum",
- "required": false,
- "type": "string"
}
],
"related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos",
"response": [
{
- "description": "the name of the secondary storage host for the template",
- "name": "hostname",
+ "description": "the project id of the template",
+ "name": "projectid",
"type": "string"
},
- {},
{
- "description": "additional key/value details tied with template",
- "name": "details",
+ "description": "VMware only: additional key/value details tied with deploy-as-is template",
+ "name": "deployasisdetails",
"type": "map"
},
{
- "description": "true if this template is a featured template, false otherwise",
- "name": "isfeatured",
- "type": "boolean"
- },
- {
- "description": "the account name to which the template belongs",
- "name": "account",
+ "description": "the ID of the OS type for this template.",
+ "name": "ostypeid",
"type": "string"
},
{
- "description": "the status of the template",
- "name": "status",
- "type": "string"
- },
- {
- "description": "the URL which the template/iso is registered from",
- "name": "url",
- "type": "string"
- },
- {
- "description": "true if template requires HVM enabled, false otherwise",
- "name": "requireshvm",
- "type": "boolean"
- },
- {
- "description": "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 type of the template",
- "name": "templatetype",
- "type": "string"
- },
- {
- "description": "checksum of the template",
- "name": "checksum",
- "type": "string"
- },
- {
- "description": "the processor bit size",
- "name": "bits",
- "type": "int"
- },
- {
- "description": "the template display text",
- "name": "displaytext",
- "type": "string"
- },
- {
- "description": "the name of the zone for this template",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "the format of the template.",
- "name": "format",
- "type": "imageformat"
- },
- {
- "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 ID of the secondary storage host for the template",
- "name": "hostid",
- "type": "string"
- },
- {
- "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 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": "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": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
"description": "the account id to which the template belongs",
"name": "accountid",
"type": "string"
},
{
- "description": "true if template is sshkey enabled, false otherwise",
- "name": "sshkeyenabled",
- "type": "boolean"
- },
- {},
- {
- "description": "the date this template was removed",
- "name": "removed",
- "type": "date"
- },
- {
- "description": "the tag of this template",
- "name": "templatetag",
- "type": "string"
- },
- {
"description": "true if the template is extractable, false otherwise",
"name": "isextractable",
"type": "boolean"
},
{
- "description": "the ID of the domain to which the template belongs",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the date this template was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "true if the template is ready to be deployed from, false otherwise.",
- "name": "isready",
- "type": "boolean"
- },
- {
- "description": "VMware only: additional key/value details tied with deploy-as-is template",
- "name": "deployasisdetails",
- "type": "map"
- },
- {
- "description": "the ID of the zone for this template",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the template ID",
- "name": "id",
- "type": "string"
- },
- {
- "description": "if Datadisk template, then id of the root disk template this template belongs to",
- "name": "parenttemplateid",
- "type": "string"
- },
- {
"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 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": "true if the reset password feature is enabled, false otherwise",
- "name": "passwordenabled",
- "type": "boolean"
+ "description": "the template display text",
+ "name": "displaytext",
+ "type": "string"
},
{
- "description": "the template ID of the parent template if present",
- "name": "sourcetemplateid",
+ "description": "the list of resource tags associated",
+ "name": "tags",
+ "response": [
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the type of the template",
+ "name": "templatetype",
+ "type": "string"
+ },
+ {
+ "description": "the account name to which the template belongs",
+ "name": "account",
"type": "string"
},
{
@@ -67582,28 +68545,8 @@
"type": "boolean"
},
{
- "description": "the ID of the OS type for this template.",
- "name": "ostypeid",
- "type": "string"
- },
- {
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "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": "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"
},
{
@@ -67612,14 +68555,181 @@
"type": "string"
},
{
+ "description": "true if the template is ready to be deployed from, false otherwise.",
+ "name": "isready",
+ "type": "boolean"
+ },
+ {
+ "description": "true if this template is a featured template, false otherwise",
+ "name": "isfeatured",
+ "type": "boolean"
+ },
+ {
+ "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": "Lists the download progress of a template across all secondary storages",
+ "name": "downloaddetails",
+ "type": "list"
+ },
+ {
+ "description": "if root disk template, then ids of the datas disk templates this template owns",
+ "name": "childtemplates",
+ "type": "set"
+ },
+ {
+ "description": "the 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 tag of this template",
+ "name": "templatetag",
+ "type": "string"
+ },
+ {
+ "description": "checksum of the template",
+ "name": "checksum",
+ "type": "string"
+ },
+ {
+ "description": "the format of the template.",
+ "name": "format",
+ "type": "imageformat"
+ },
+ {
+ "description": "the template ID",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "true if template is sshkey enabled, false otherwise",
+ "name": "sshkeyenabled",
+ "type": "boolean"
+ },
+ {
+ "description": "the processor bit size",
+ "name": "bits",
+ "type": "int"
+ },
+ {
+ "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": "additional key/value details tied with template",
+ "name": "details",
+ "type": "map"
+ },
+ {
+ "description": "the project name of the template",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "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 status of the template",
+ "name": "status",
+ "type": "string"
+ },
+ {
+ "description": "the hypervisor on which the template runs",
+ "name": "hypervisor",
+ "type": "string"
+ },
+ {
+ "description": "true if this template is a public template, false otherwise",
+ "name": "ispublic",
+ "type": "boolean"
+ },
+ {
+ "description": "the name of the OS type for this template.",
+ "name": "ostypename",
+ "type": "string"
+ },
+ {
+ "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage",
+ "name": "directdownload",
+ "type": "boolean"
+ },
+ {
+ "description": "the ID of the domain to which the template belongs",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.",
+ "name": "deployasis",
+ "type": "boolean"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the name of the zone for this template",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the zone for this template",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the date this template was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
"description": "the size of the template",
"name": "size",
"type": "long"
+ },
+ {
+ "description": "the date this template was removed",
+ "name": "removed",
+ "type": "date"
+ },
+ {},
+ {
+ "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"
}
]
},
@@ -67629,28 +68739,6 @@
"name": "listCiscoAsa1000vResources",
"params": [
{
- "description": "Hostname or ip address of the Cisco ASA 1000v appliance.",
- "length": 255,
- "name": "hostname",
- "required": false,
- "type": "string"
- },
- {
- "description": "",
- "length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
- },
- {
- "description": "Cisco ASA 1000v resource ID",
- "length": 255,
- "name": "resourceid",
- "related": "addCiscoAsa1000vResource,listCiscoAsa1000vResources",
- "required": false,
- "type": "uuid"
- },
- {
"description": "the Physical Network ID",
"length": 255,
"name": "physicalnetworkid",
@@ -67671,6 +68759,28 @@
"name": "page",
"required": false,
"type": "integer"
+ },
+ {
+ "description": "Hostname or ip address of the Cisco ASA 1000v appliance.",
+ "length": 255,
+ "name": "hostname",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "Cisco ASA 1000v resource ID",
+ "length": 255,
+ "name": "resourceid",
+ "related": "addCiscoAsa1000vResource,listCiscoAsa1000vResources",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
}
],
"related": "addCiscoAsa1000vResource",
@@ -67679,15 +68789,15 @@
{},
{},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
{},
{},
{},
@@ -67700,6 +68810,14 @@
"name": "deployNetscalerVpx",
"params": [
{
+ "description": "the ID of the service offering for the virtual machine",
+ "length": 255,
+ "name": "serviceofferingid",
+ "related": "updateServiceOffering,listServiceOfferings",
+ "required": true,
+ "type": "uuid"
+ },
+ {
"description": "availability zone for the virtual machine",
"length": 255,
"name": "zoneid",
@@ -67708,10 +68826,10 @@
"type": "uuid"
},
{
- "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": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos",
"required": true,
"type": "uuid"
},
@@ -67722,22 +68840,26 @@
"related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks",
"required": false,
"type": "uuid"
- },
- {
- "description": "the ID of the template for the virtual machine",
- "length": 255,
- "name": "templateid",
- "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos",
- "required": true,
- "type": "uuid"
}
],
"related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter",
"response": [
{
- "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider",
- "name": "isexclusivegslbprovider",
- "type": "boolean"
+ "description": "private IP of the NetScaler representing GSLB site",
+ "name": "gslbproviderprivateip",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the public interface of the load balancer",
+ "name": "publicinterface",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "name of the provider",
+ "name": "provider",
+ "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.",
@@ -67745,39 +68867,8 @@
"type": "list"
},
{
- "description": "true if NetScaler device is provisioned to be a GSLB service provider",
- "name": "gslbprovider",
- "type": "boolean"
- },
- {
- "description": "device capacity",
- "name": "lbdevicecapacity",
- "type": "long"
- },
- {
- "description": "the private interface of the load balancer",
- "name": "privateinterface",
- "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"
- },
- {},
- {
- "description": "the management IP address of the external load balancer",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "description": "name of the provider",
- "name": "provider",
+ "description": "device name",
+ "name": "lbdevicename",
"type": "string"
},
{
@@ -67786,14 +68877,19 @@
"type": "string"
},
{
- "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",
+ "type": "boolean"
},
{
- "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": "true if NetScaler device is provisioned to be a GSLB service provider",
+ "name": "gslbprovider",
+ "type": "boolean"
},
{
"description": "device id of the netscaler load balancer",
@@ -67801,13 +68897,23 @@
"type": "string"
},
{
+ "description": "the private interface of the load balancer",
+ "name": "privateinterface",
+ "type": "string"
+ },
+ {
"description": "the physical network to which this netscaler device belongs to",
"name": "physicalnetworkid",
"type": "string"
},
{
- "description": "device name",
- "name": "lbdevicename",
+ "description": "the management IP address of the external load balancer",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
@@ -67815,7 +68921,11 @@
"name": "lbdevicededicated",
"type": "boolean"
},
- {},
+ {
+ "description": "device capacity",
+ "name": "lbdevicecapacity",
+ "type": "long"
+ },
{
"description": "device state",
"name": "lbdevicestate",
@@ -67838,48 +68948,48 @@
],
"related": "",
"response": [
+ {},
{
- "description": "graceallowed",
- "name": "graceallowed",
+ "description": "the id of the volume",
+ "name": "id",
"type": "string"
},
+ {},
{
- "description": "the name of the volume",
- "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": "compression",
"name": "compression",
"type": "string"
},
{
+ "description": "graceallowed",
+ "name": "graceallowed",
+ "type": "string"
+ },
+ {
"description": "deduplication",
"name": "deduplication",
"type": "string"
},
{
- "description": "the id of the volume",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
"description": "syncronization",
"name": "sync",
"type": "string"
},
- {},
- {}
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the name of the volume",
+ "name": "name",
+ "type": "string"
+ }
]
},
{
@@ -67898,27 +69008,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"
+ }
]
},
{
@@ -67934,6 +69044,20 @@
"type": "string"
},
{
+ "description": "type of pxe device",
+ "length": 255,
+ "name": "pxeservertype",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "Credentials to reach external pxe device",
+ "length": 255,
+ "name": "username",
+ "required": true,
+ "type": "string"
+ },
+ {
"description": "Credentials to reach external pxe device",
"length": 255,
"name": "password",
@@ -67956,46 +69080,32 @@
"type": "uuid"
},
{
- "description": "Credentials to reach external pxe device",
- "length": 255,
- "name": "username",
- "required": true,
- "type": "string"
- },
- {
"description": "the Physical Network ID",
"length": 255,
"name": "physicalnetworkid",
"related": "createPhysicalNetwork",
"required": true,
"type": "uuid"
- },
- {
- "description": "type of pxe device",
- "length": 255,
- "name": "pxeservertype",
- "required": true,
- "type": "string"
}
],
"related": "",
"response": [
- {},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "name of the provider",
+ "name": "provider",
"type": "string"
},
- {},
{
"description": "the physical network to which this external dhcp device belongs to",
"name": "physicalnetworkid",
"type": "string"
},
+ {},
+ {},
{
- "description": "name of the provider",
- "name": "provider",
- "type": "string"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
{
"description": "url",
@@ -68008,14 +69118,14 @@
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
"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",
+ "type": "string"
}
]
},
@@ -68025,14 +69135,6 @@
"name": "listNiciraNvpDevices",
"params": [
{
- "description": "nicira nvp device ID",
- "length": 255,
- "name": "nvpdeviceid",
- "related": "addNiciraNvpDevice,listNiciraNvpDevices",
- "required": false,
- "type": "uuid"
- },
- {
"description": "",
"length": 255,
"name": "page",
@@ -68040,11 +69142,11 @@
"type": "integer"
},
{
- "description": "List by keyword",
+ "description": "",
"length": 255,
- "name": "keyword",
+ "name": "pagesize",
"required": false,
- "type": "string"
+ "type": "integer"
},
{
"description": "the Physical Network ID",
@@ -68055,23 +69157,31 @@
"type": "uuid"
},
{
- "description": "",
+ "description": "List by keyword",
"length": 255,
- "name": "pagesize",
+ "name": "keyword",
"required": false,
- "type": "integer"
+ "type": "string"
+ },
+ {
+ "description": "nicira nvp device ID",
+ "length": 255,
+ "name": "nvpdeviceid",
+ "related": "addNiciraNvpDevice,listNiciraNvpDevices",
+ "required": false,
+ "type": "uuid"
}
],
"related": "addNiciraNvpDevice",
"response": [
{
- "description": "device name",
- "name": "niciradevicename",
+ "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"
},
{
@@ -68080,14 +69190,8 @@
"type": "string"
},
{
- "description": "this L2 gateway service Uuid",
- "name": "l2gatewayserviceuuid",
- "type": "string"
- },
- {},
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "device id of the Nicire Nvp",
+ "name": "nvpdeviceid",
"type": "string"
},
{
@@ -68095,20 +69199,26 @@
"name": "physicalnetworkid",
"type": "string"
},
+ {},
+ {},
+ {
+ "description": "the controller Ip address",
+ "name": "hostname",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
{
"description": "name of the provider",
"name": "provider",
"type": "string"
},
{
- "description": "device id of the Nicire Nvp",
- "name": "nvpdeviceid",
- "type": "string"
- },
- {},
- {
- "description": "the controller Ip address",
- "name": "hostname",
+ "description": "this L3 gateway service Uuid",
+ "name": "l3gatewayserviceuuid",
"type": "string"
},
{
@@ -68146,11 +69256,12 @@
"type": "integer"
},
{
- "description": "List by keyword",
+ "description": "the ID of the alert",
"length": 255,
- "name": "keyword",
+ "name": "id",
+ "related": "listAlerts",
"required": false,
- "type": "string"
+ "type": "uuid"
},
{
"description": "list by alert type",
@@ -68160,36 +69271,40 @@
"type": "string"
},
{
- "description": "the ID of the alert",
+ "description": "List by keyword",
"length": 255,
- "name": "id",
- "related": "listAlerts",
+ "name": "keyword",
"required": false,
- "type": "uuid"
+ "type": "string"
}
],
"related": "",
"response": [
- {},
- {},
{
"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 name of the alert",
+ "name": "name",
+ "type": "string"
},
+ {},
+ {},
{
"description": "the date and time the alert was sent",
"name": "sent",
"type": "date"
},
{
- "description": "the name of the alert",
- "name": "name",
+ "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"
},
{
@@ -68198,14 +69313,9 @@
"type": "short"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the id of the alert",
- "name": "id",
- "type": "string"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
}
]
},
@@ -68223,48 +69333,72 @@
"type": "list"
},
{
- "description": "the ID of the service offering for the virtual machine",
+ "description": "destination Host ID to deploy the VM to - parameter available for root admin only",
"length": 255,
- "name": "serviceofferingid",
- "related": "updateServiceOffering,listServiceOfferings",
- "required": true,
+ "name": "hostid",
+ "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost",
+ "required": false,
"type": "uuid"
},
{
- "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId",
+ "description": "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter",
"length": 255,
- "name": "size",
+ "name": "networkids",
+ "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks",
"required": false,
- "type": "long"
+ "type": "list"
},
{
- "description": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)",
+ "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": "bootintosetup",
+ "name": "datadiskofferinglist",
"required": false,
- "since": "4.15.0.0",
- "type": "boolean"
- },
- {
- "description": "true if virtual machine needs to be dynamically scalable",
- "length": 255,
- "name": "dynamicscalingenabled",
- "required": false,
- "since": "4.16",
- "type": "boolean"
- },
- {
- "description": "ip to network mapping. Can't be specified with networkIds parameter. Example: iptonetworklist[0].ip=10.10.10.11&iptonetworklist[0].ipv6=fc00:1234:5678::abcd&iptonetworklist[0].networkid=uuid&iptonetworklist[0].mac=aa:bb:cc:dd:ee::ff - requests to use ip 10.10.10.11 in network id=uuid",
- "length": 255,
- "name": "iptonetworklist",
- "required": false,
+ "since": "4.11",
"type": "map"
},
{
- "description": "DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com",
+ "description": "comma separated list of security groups names that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter",
"length": 255,
- "name": "dhcpoptionsnetworklist",
+ "name": "securitygroupnames",
+ "related": "createSecurityGroup",
"required": false,
+ "type": "list"
+ },
+ {
+ "description": "true if start vm after creating; defaulted to true if not specified",
+ "length": 255,
+ "name": "startvm",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "an optional user generated name for the virtual machine",
+ "length": 255,
+ "name": "displayname",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "Guest VM Boot option either custom[UEFI] or default boot [BIOS]. Not applicable with VMware, as we honour what is defined in the template.",
+ "length": 255,
+ "name": "boottype",
+ "required": false,
+ "since": "4.14.0.0",
+ "type": "string"
+ },
+ {
+ "description": "name of the ssh key pair used to login to the virtual machine",
+ "length": 255,
+ "name": "keypair",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "used to specify the vApp properties.",
+ "length": 255,
+ "name": "properties",
+ "required": false,
+ "since": "4.15",
"type": "map"
},
{
@@ -68276,36 +69410,43 @@
"type": "list"
},
{
- "description": "an optional user generated name for the virtual machine",
+ "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId",
"length": 255,
- "name": "displayname",
+ "name": "size",
"required": false,
- "type": "string"
+ "type": "long"
},
{
- "description": "true if start vm after creating; defaulted to true if not specified",
+ "description": "availability zone for the virtual machine",
"length": 255,
- "name": "startvm",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "Guest VM Boot option either custom[UEFI] or default boot [BIOS]. Not applicable with VMware, as we honour what is defined in the template.",
- "length": 255,
- "name": "boottype",
- "required": false,
- "since": "4.14.0.0",
- "type": "string"
- },
- {
- "description": "Deploy vm for the project",
- "length": 255,
- "name": "projectid",
- "related": "listProjectAccounts,activateProject,suspendProject,updateProject",
- "required": false,
+ "name": "zoneid",
+ "related": "createZone,updateZone,listZones,listZones",
+ "required": true,
"type": "uuid"
},
{
+ "description": "the ID of the service offering for the virtual machine",
+ "length": 255,
+ "name": "serviceofferingid",
+ "related": "updateServiceOffering,listServiceOfferings",
+ "required": true,
+ "type": "uuid"
+ },
+ {
+ "description": "host name for the virtual machine",
+ "length": 255,
+ "name": "name",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the mac address for default vm's network",
+ "length": 255,
+ "name": "macaddress",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "an optional group for the virtual machine",
"length": 255,
"name": "group",
@@ -68313,21 +69454,115 @@
"type": "string"
},
{
- "description": "Deployment planner to use for vm allocation. Available to ROOT admin only",
+ "description": "Boot Mode [Legacy] or [Secure] Applicable when Boot Type Selected is UEFI, otherwise Legacy only for BIOS. Not applicable with VMware, as we honour what is defined in the template.",
"length": 255,
- "name": "deploymentplanner",
+ "name": "bootmode",
"required": false,
- "since": "4.4",
+ "since": "4.14.0.0",
"type": "string"
},
{
- "description": "the ip address for default vm's network",
+ "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": "ipaddress",
+ "name": "iptonetworklist",
+ "required": false,
+ "type": "map"
+ },
+ {
+ "description": "an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us",
+ "length": 255,
+ "name": "keyboard",
"required": false,
"type": "string"
},
{
+ "description": "the ID of the disk offering for the virtual machine. If the template is of ISO format, the diskOfferingId is for the root disk volume. Otherwise this parameter is used to indicate the offering for the data disk volume. If the templateId parameter passed is from a Template object, the diskOfferingId refers to a DATA Disk Volume created. If the templateId parameter passed is from an ISO object, the diskOfferingId refers to a ROOT Disk Volume created.",
+ "length": 255,
+ "name": "diskofferingid",
+ "related": "createDiskOffering",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)",
+ "length": 255,
+ "name": "bootintosetup",
+ "required": false,
+ "since": "4.15.0.0",
+ "type": "boolean"
+ },
+ {
+ "description": "destination Cluster ID to deploy the VM to - parameter available for root admin only",
+ "length": 255,
+ "name": "clusterid",
+ "related": "addCluster",
+ "required": false,
+ "since": "4.13",
+ "type": "uuid"
+ },
+ {
+ "description": "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.",
+ "length": 1048576,
+ "name": "userdata",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the ID of the template for the virtual machine",
+ "length": 255,
+ "name": "templateid",
+ "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos",
+ "required": true,
+ "type": "uuid"
+ },
+ {
+ "description": "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details",
+ "length": 255,
+ "name": "details",
+ "required": false,
+ "since": "4.3",
+ "type": "map"
+ },
+ {
+ "description": "destination Pod ID to deploy the VM to - parameter available for root admin only",
+ "length": 255,
+ "name": "podid",
+ "related": "updatePod,createManagementNetworkIpRange",
+ "required": false,
+ "since": "4.13",
+ "type": "uuid"
+ },
+ {
+ "description": "DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com",
+ "length": 255,
+ "name": "dhcpoptionsnetworklist",
+ "required": false,
+ "type": "map"
+ },
+ {
+ "description": "the ipv6 address for default vm's network",
+ "length": 255,
+ "name": "ip6address",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "an optional field, whether to the display the vm to the end user or not.",
+ "length": 255,
+ "name": "displayvm",
+ "required": false,
+ "since": "4.2",
+ "type": "boolean"
+ },
+ {
+ "description": "true if virtual machine needs to be dynamically scalable",
+ "length": 255,
+ "name": "dynamicscalingenabled",
+ "required": false,
+ "since": "4.16",
+ "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",
@@ -68343,91 +69578,13 @@
"type": "string"
},
{
- "description": "Boot Mode [Legacy] or [Secure] Applicable when Boot Type Selected is UEFI, otherwise Legacy only for BIOS. Not applicable with VMware, as we honour what is defined in the template.",
+ "description": "the ip address for default vm's network",
"length": 255,
- "name": "bootmode",
- "required": false,
- "since": "4.14.0.0",
- "type": "string"
- },
- {
- "description": "comma separated list of security groups names that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter",
- "length": 255,
- "name": "securitygroupnames",
- "related": "createSecurityGroup",
- "required": false,
- "type": "list"
- },
- {
- "description": "VMware only: used to specify network mapping of a vApp VMware template registered \"as-is\". Example nicnetworklist[0].ip=Nic-101&nicnetworklist[0].network=uuid",
- "length": 255,
- "name": "nicnetworklist",
- "required": false,
- "since": "4.15",
- "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.",
- "length": 255,
- "name": "diskofferingid",
- "related": "createDiskOffering",
- "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",
- "length": 255,
- "name": "customid",
+ "name": "ipaddress",
"required": false,
"type": "string"
},
{
- "description": "the ID of the template for the virtual machine",
- "length": 255,
- "name": "templateid",
- "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos",
- "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",
- "required": false,
- "since": "4.13",
- "type": "uuid"
- },
- {
- "description": "name of the ssh key pair used to login to the virtual machine",
- "length": 255,
- "name": "keypair",
- "required": false,
- "type": "string"
- },
- {
- "description": "the hypervisor on which to deploy the virtual machine. The parameter is required and respected only when hypervisor info is not set on the ISO/Template passed to the call",
- "length": 255,
- "name": "hypervisor",
- "required": false,
- "type": "string"
- },
- {
- "description": "the ipv6 address for default vm's network",
- "length": 255,
- "name": "ip6address",
- "required": false,
- "type": "string"
- },
- {
- "description": "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter",
- "length": 255,
- "name": "networkids",
- "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks",
- "required": false,
- "type": "list"
- },
- {
"description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.",
"length": 255,
"name": "domainid",
@@ -68436,6 +69593,14 @@
"type": "uuid"
},
{
+ "description": "Deploy vm for the project",
+ "length": 255,
+ "name": "projectid",
+ "related": "listProjectAccounts,activateProject,suspendProject,updateProject",
+ "required": false,
+ "type": "uuid"
+ },
+ {
"description": "if true the image tags (if any) will be copied to the VM, default value is false",
"length": 255,
"name": "copyimagetags",
@@ -68444,13 +69609,36 @@
"type": "boolean"
},
{
- "description": "host name for the virtual machine",
+ "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only",
"length": 255,
- "name": "name",
+ "name": "customid",
"required": false,
"type": "string"
},
{
+ "description": "the hypervisor on which to deploy the virtual machine. The parameter is required and respected only when hypervisor info is not set on the ISO/Template passed to the call",
+ "length": 255,
+ "name": "hypervisor",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "Optional field to resize root disk on deploy. Value is in GB. Only applies to template-based deployments. Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided",
+ "length": 255,
+ "name": "rootdisksize",
+ "required": false,
+ "since": "4.4",
+ "type": "long"
+ },
+ {
+ "description": "Deployment planner to use for vm allocation. Available to ROOT admin only",
+ "length": 255,
+ "name": "deploymentplanner",
+ "required": false,
+ "since": "4.4",
+ "type": "string"
+ },
+ {
"description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment",
"length": 5120,
"name": "extraconfig",
@@ -68459,506 +69647,59 @@
"type": "string"
},
{
- "description": "used to specify the vApp properties.",
+ "description": "VMware only: used to specify network mapping of a vApp VMware template registered \"as-is\". Example nicnetworklist[0].ip=Nic-101&nicnetworklist[0].network=uuid",
"length": 255,
- "name": "properties",
+ "name": "nicnetworklist",
"required": false,
"since": "4.15",
"type": "map"
- },
- {
- "description": "destination Host ID to deploy the VM to - parameter available for root admin only",
- "length": 255,
- "name": "hostid",
- "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost",
- "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.",
- "length": 1048576,
- "name": "userdata",
- "required": false,
- "type": "string"
- },
- {
- "description": "an optional field, whether to the display the vm to the end user or not.",
- "length": 255,
- "name": "displayvm",
- "required": false,
- "since": "4.2",
- "type": "boolean"
- },
- {
- "description": "the mac address for default vm's network",
- "length": 255,
- "name": "macaddress",
- "required": false,
- "type": "string"
- },
- {
- "description": "availability zone for the virtual machine",
- "length": 255,
- "name": "zoneid",
- "related": "createZone,updateZone,listZones,listZones",
- "required": true,
- "type": "uuid"
- },
- {
- "description": "destination Pod ID to deploy the VM to - parameter available for root admin only",
- "length": 255,
- "name": "podid",
- "related": "updatePod,createManagementNetworkIpRange",
- "required": false,
- "since": "4.13",
- "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",
- "length": 255,
- "name": "datadiskofferinglist",
- "required": false,
- "since": "4.11",
- "type": "map"
- },
- {
- "description": "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details",
- "length": 255,
- "name": "details",
- "required": false,
- "since": "4.3",
- "type": "map"
- },
- {
- "description": "an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us",
- "length": 255,
- "name": "keyboard",
- "required": false,
- "type": "string"
- },
- {
- "description": "Optional field to resize root disk on deploy. Value is in GB. Only applies to template-based deployments. Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided",
- "length": 255,
- "name": "rootdisksize",
- "required": false,
- "since": "4.4",
- "type": "long"
}
],
"related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance",
"response": [
{
- "description": "the user's ID who deployed the virtual machine",
- "name": "userid",
- "type": "string"
- },
- {},
- {
- "description": "Vm details in key/value pairs.",
- "name": "details",
- "type": "map"
- },
- {
- "description": "List of read-only Vm details as comma separated string.",
- "name": "readonlydetails",
- "type": "string"
- },
- {
- "description": "device ID of the root volume",
- "name": "rootdeviceid",
- "type": "long"
- },
- {
- "description": "the virtual network for the service offering",
- "name": "forvirtualnetwork",
- "type": "boolean"
- },
- {
- "description": "the name of the domain in which the virtual machine exists",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "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": "public IP address id associated with vm via Static nat rule",
"name": "publicip",
"type": "string"
},
{
- "description": "public IP address id associated with vm via Static nat rule",
- "name": "publicipid",
- "type": "string"
- },
- {
- "description": "the read (bytes) of disk on the vm",
- "name": "diskkbsread",
- "type": "long"
- },
- {
- "description": "the date when this virtual machine was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "Os type ID of the virtual machine",
- "name": "guestosid",
- "type": "string"
- },
- {
- "description": "true if high-availability is enabled, false otherwise",
- "name": "haenable",
- "type": "boolean"
- },
- {
- "description": "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 hypervisor on which the template runs",
- "name": "hypervisor",
- "type": "string"
- },
- {
- "description": "the name of the virtual machine",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the memory used by the vm",
- "name": "memorykbs",
- "type": "long"
- },
- {
- "description": "the outgoing network traffic on the host",
- "name": "networkkbswrite",
- "type": "long"
- },
- {
- "description": "the pool type of the virtual machine",
- "name": "pooltype",
- "type": "string"
- },
- {
- "description": "the project name of the vm",
- "name": "project",
- "type": "string"
- },
- {
- "description": " an alternate display text of the template for the virtual machine",
- "name": "templatedisplaytext",
- "type": "string"
- },
- {
- "description": "the number of cpu this virtual machine is running with",
- "name": "cpunumber",
- "type": "integer"
- },
- {
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
- },
- {},
- {
- "description": "the list of nics associated with vm",
- "name": "nic",
- "response": [
- {
- "description": "the type of the nic",
- "name": "type",
- "type": "string"
- },
- {
- "description": "the isolated private VLAN type if available",
- "name": "isolatedpvlantype",
- "type": "string"
- },
- {
- "description": "the name of the corresponding network",
- "name": "networkname",
- "type": "string"
- },
- {
- "description": "Type of adapter if available",
- "name": "adaptertype",
- "type": "string"
- },
- {
- "description": "the ip address of the nic",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "description": "the extra dhcp options on the nic",
- "name": "extradhcpoption",
- "type": "list"
- },
- {
- "description": "the isolated private VLAN if available",
- "name": "isolatedpvlan",
- "type": "integer"
- },
- {
- "description": "true if nic is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
- },
- {
- "description": "Id of the NSX Logical Switch (if NSX based), null otherwise",
- "name": "nsxlogicalswitch",
- "type": "string"
- },
- {
- "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise",
- "name": "nsxlogicalswitchport",
- "type": "string"
- },
- {
- "description": "the netmask of the nic",
- "name": "netmask",
- "type": "string"
- },
- {
- "description": "the traffic type of the nic",
- "name": "traffictype",
- "type": "string"
- },
- {
- "description": "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 isolation uri of the nic",
- "name": "isolationuri",
- "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 ID of the corresponding network",
- "name": "networkid",
- "type": "string"
- },
- {
- "description": "the gateway of IPv6 network",
- "name": "ip6gateway",
- "type": "string"
- },
- {
- "description": "the cidr of IPv6 network",
- "name": "ip6cidr",
- "type": "string"
- },
- {
- "description": "the broadcast uri of the nic",
- "name": "broadcasturi",
- "type": "string"
- },
- {
- "description": "true if nic is default, false otherwise",
- "name": "macaddress",
- "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 nic",
- "name": "id",
- "type": "string"
- },
- {
- "description": "ID of the VLAN/VNI if available",
- "name": "vlanid",
- "type": "integer"
- }
- ],
- "type": "set"
- },
- {
- "description": "the state of the virtual machine",
- "name": "state",
- "type": "string"
- },
- {
- "description": "the name of the host for the virtual machine",
- "name": "hostname",
- "type": "string"
- },
- {
- "description": "the total number of network traffic bytes received",
- "name": "receivedbytes",
- "type": "long"
- },
- {
"description": "the memory allocated for the virtual machine",
"name": "memory",
"type": "integer"
},
{
- "description": "the group ID of the virtual machine",
- "name": "groupid",
+ "description": "the date when this virtual machine was updated last time",
+ "name": "lastupdated",
+ "type": "date"
+ },
+ {
+ "description": "Guest vm Boot Type",
+ "name": "boottype",
"type": "string"
},
{
- "description": "the ID of the host for the virtual machine",
- "name": "hostid",
- "type": "string"
- },
- {
- "description": "an alternate display text of the ISO attached to the virtual machine",
- "name": "isodisplaytext",
- "type": "string"
- },
- {
- "description": "the name of the disk offering of the virtual machine",
- "name": "diskofferingname",
- "type": "string"
- },
- {
- "description": "the name of the availability zone for the virtual machine",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "the password (if exists) of the virtual machine",
- "name": "password",
- "type": "string"
- },
- {
- "description": "the ID of the availablility 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",
+ "description": "the virtual network for the service offering",
+ "name": "forvirtualnetwork",
"type": "boolean"
},
{
- "description": "OS name of the vm",
- "name": "osdisplayname",
- "type": "string"
- },
- {
- "description": "the incoming network traffic on the vm",
- "name": "networkkbsread",
+ "description": "the memory used by the vm",
+ "name": "memorykbs",
"type": "long"
},
{
- "description": "the speed of each cpu",
- "name": "cpuspeed",
- "type": "integer"
- },
- {
"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": "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",
- "type": "string"
- },
- {
- "description": "the project id of the vm",
- "name": "projectid",
- "type": "string"
- },
- {
"description": "the total number of network traffic bytes sent",
"name": "sentbytes",
"type": "long"
},
{
- "description": "the ID of the 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 date when this virtual machine was updated last time",
- "name": "lastupdated",
- "type": "date"
- },
- {
- "description": "the target memory in vm",
- "name": "memorytargetkbs",
- "type": "long"
- },
- {
- "description": "device type of the root volume",
- "name": "rootdevicetype",
- "type": "string"
- },
- {
- "description": "the ID of the service offering of the virtual machine",
- "name": "serviceofferingid",
- "type": "string"
- },
- {
- "description": "the internal memory that's free in vm or zero if it can not be calculated",
- "name": "memoryintfreekbs",
- "type": "long"
- },
- {
- "description": "ssh key-pair",
- "name": "keypair",
+ "description": "the name of the service offering of the virtual machine",
+ "name": "serviceofferingname",
"type": "string"
},
{
@@ -68967,17 +69708,784 @@
"type": "string"
},
{
+ "description": "the name of the domain in which the virtual machine exists",
+ "name": "domain",
+ "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": "the user's name who deployed the virtual machine",
+ "name": "username",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the virtual machine",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "OS type id of the vm",
+ "name": "ostypeid",
+ "type": "string"
+ },
+ {
+ "description": "the total number of network traffic bytes received",
+ "name": "receivedbytes",
+ "type": "long"
+ },
+ {
+ "description": "the group ID of the virtual machine",
+ "name": "groupid",
+ "type": "string"
+ },
+ {
+ "description": "State of the Service from LB rule",
+ "name": "servicestate",
+ "type": "string"
+ },
+ {
"description": "the write (bytes) of disk on the vm",
"name": "diskkbswrite",
"type": "long"
},
{
+ "description": "the name of the disk offering of the virtual machine",
+ "name": "diskofferingname",
+ "type": "string"
+ },
+ {
+ "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",
+ "type": "string"
+ },
+ {
+ "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": "Vm details in key/value pairs.",
+ "name": "details",
+ "type": "map"
+ },
+ {
+ "description": "the group name of the virtual machine",
+ "name": "group",
+ "type": "string"
+ },
+ {
+ "description": "the target memory in vm",
+ "name": "memorytargetkbs",
+ "type": "long"
+ },
+ {
+ "description": "the ID of the service offering of the virtual machine",
+ "name": "serviceofferingid",
+ "type": "string"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "Os type ID of the virtual machine",
+ "name": "guestosid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the project name of the vm",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "description": "device ID of the root volume",
+ "name": "rootdeviceid",
+ "type": "long"
+ },
+ {
+ "description": "the name of the template for the virtual machine",
+ "name": "templatename",
+ "type": "string"
+ },
+ {
+ "description": "the project id of the vm",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the date when this virtual machine was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the internal memory 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 write (io) of disk on the vm",
+ "name": "diskiowrite",
+ "type": "long"
+ },
+ {
+ "description": "the read (bytes) of disk on the vm",
+ "name": "diskkbsread",
+ "type": "long"
+ },
+ {
+ "description": "true if high-availability is enabled, false otherwise",
+ "name": "haenable",
+ "type": "boolean"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the user's ID who deployed the virtual machine",
+ "name": "userid",
+ "type": "string"
+ },
+ {
+ "description": "the list of nics associated with vm",
+ "name": "nic",
+ "response": [
+ {
+ "description": "the ip address of the nic",
+ "name": "ipaddress",
+ "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 broadcast uri of the nic",
+ "name": "broadcasturi",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the nic",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the corresponding network",
+ "name": "networkid",
+ "type": "string"
+ },
+ {
+ "description": "the IPv6 address of network",
+ "name": "ip6address",
+ "type": "string"
+ },
+ {
+ "description": "Type of adapter if available",
+ "name": "adaptertype",
+ "type": "string"
+ },
+ {
+ "description": "the gateway of the nic",
+ "name": "gateway",
+ "type": "string"
+ },
+ {
+ "description": "the traffic type of the nic",
+ "name": "traffictype",
+ "type": "string"
+ },
+ {
+ "description": "ID of the VLAN/VNI if available",
+ "name": "vlanid",
+ "type": "integer"
+ },
+ {
+ "description": "the 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 cidr of IPv6 network",
+ "name": "ip6cidr",
+ "type": "string"
+ },
+ {
+ "description": "the isolated private VLAN type if available",
+ "name": "isolatedpvlantype",
+ "type": "string"
+ },
+ {
+ "description": "the Secondary ipv4 addr of nic",
+ "name": "secondaryip",
+ "type": "list"
+ },
+ {
+ "description": "true if nic is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {
+ "description": "the type of the nic",
+ "name": "type",
+ "type": "string"
+ },
+ {
+ "description": "the extra dhcp options on the nic",
+ "name": "extradhcpoption",
+ "type": "list"
+ },
+ {
+ "description": "the gateway of IPv6 network",
+ "name": "ip6gateway",
+ "type": "string"
+ },
+ {
+ "description": "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": "Id of the vm to which the nic belongs",
+ "name": "virtualmachineid",
+ "type": "string"
+ },
+ {
+ "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise",
+ "name": "nsxlogicalswitchport",
+ "type": "string"
+ },
+ {
+ "description": "the isolated private VLAN if available",
+ "name": "isolatedpvlan",
+ "type": "integer"
+ },
+ {
+ "description": "IP addresses associated with NIC found for unmanaged VM",
+ "name": "ipaddresses",
+ "type": "list"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "an alternate display text of the ISO attached to the virtual machine",
+ "name": "isodisplaytext",
+ "type": "string"
+ },
+ {
+ "description": "ssh key-pair",
+ "name": "keypair",
+ "type": "string"
+ },
+ {
+ "description": "the hypervisor on which the template runs",
+ "name": "hypervisor",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.",
+ "name": "templateid",
+ "type": "string"
+ },
+ {
+ "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.",
+ "name": "isdynamicallyscalable",
+ "type": "boolean"
+ },
+ {
+ "description": "Guest vm Boot Mode",
+ "name": "bootmode",
+ "type": "string"
+ },
+ {
+ "description": "OS name of the vm",
+ "name": "osdisplayname",
+ "type": "string"
+ },
+ {
+ "description": "the pool type of the virtual machine",
+ "name": "pooltype",
+ "type": "string"
+ },
+ {
+ "description": "the password (if exists) of the virtual machine",
+ "name": "password",
+ "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 availablility zone for the virtual machine",
+ "name": "zoneid",
+ "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 name of the security group",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID of the security group",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the domain name of the security group",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the number of virtualmachines associated with this securitygroup",
+ "name": "virtualmachinecount",
+ "type": "integer"
+ },
+ {
+ "description": "the 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 project id of the group",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the list of egress rules associated with the security group",
+ "name": "egressrule",
+ "response": [
+ {
+ "description": "the ending IP of the security group rule ",
+ "name": "endport",
+ "type": "integer"
+ },
+ {
+ "description": "security group name",
+ "name": "securitygroupname",
+ "type": "string"
+ },
+ {
+ "description": "the type of the ICMP message response",
+ "name": "icmptype",
+ "type": "integer"
+ },
+ {
+ "description": "the code for the ICMP message response",
+ "name": "icmpcode",
+ "type": "integer"
+ },
+ {
+ "description": "account owning the security group rule",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the CIDR notation for the base IP address of the security group rule",
+ "name": "cidr",
+ "type": "string"
+ },
+ {
+ "description": "the starting IP of the security group rule",
+ "name": "startport",
+ "type": "integer"
+ },
+ {
+ "description": "the id of the security group rule",
+ "name": "ruleid",
+ "type": "string"
+ },
+ {
+ "description": "the list of resource tags associated with the rule",
+ "name": "tags",
+ "response": [
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "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": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the protocol of the security group rule",
+ "name": "protocol",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "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": "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": "security group name",
+ "name": "securitygroupname",
+ "type": "string"
+ },
+ {
+ "description": "the id of the security group rule",
+ "name": "ruleid",
+ "type": "string"
+ },
+ {
+ "description": "the protocol of the security group rule",
+ "name": "protocol",
+ "type": "string"
+ },
+ {
+ "description": "the type of the ICMP message response",
+ "name": "icmptype",
+ "type": "integer"
+ },
+ {
+ "description": "the list of resource tags associated with the rule",
+ "name": "tags",
+ "response": [
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "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 name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the code for the ICMP message response",
+ "name": "icmpcode",
+ "type": "integer"
+ },
+ {
+ "description": "the ending IP of the security group rule ",
+ "name": "endport",
+ "type": "integer"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the list of resource tags associated with the rule",
+ "name": "tags",
+ "response": [
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ }
+ ],
+ "type": "set"
+ },
+ {},
+ {
+ "description": "the name of the backup offering of the virtual machine",
+ "name": "backupofferingname",
+ "type": "string"
+ },
+ {
+ "description": "List of read-only Vm details as comma separated string.",
+ "name": "readonlydetails",
+ "type": "string"
+ },
+ {
+ "description": "public IP address id associated with vm via Static nat rule",
+ "name": "publicipid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the incoming network traffic on the vm",
+ "name": "networkkbsread",
+ "type": "long"
+ },
+ {
+ "description": "device type of the root volume",
+ "name": "rootdevicetype",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the disk offering of the virtual machine",
+ "name": "diskofferingid",
+ "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",
+ "name": "networkkbswrite",
+ "type": "long"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "an optional field whether to the display the vm to the end user or not.",
+ "name": "displayvm",
+ "type": "boolean"
+ },
+ {
+ "description": "the speed of each cpu",
+ "name": "cpuspeed",
+ "type": "integer"
+ },
+ {
+ "description": "the account associated with the virtual machine",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the name of the ISO attached to the virtual machine",
+ "name": "isoname",
+ "type": "string"
+ },
+ {
+ "description": "the name of the host for the virtual machine",
+ "name": "hostname",
+ "type": "string"
+ },
+ {
+ "description": " an alternate display text of the template for the virtual machine",
+ "name": "templatedisplaytext",
+ "type": "string"
+ },
+ {
"description": "list of affinity groups associated with the virtual machine",
"name": "affinitygroup",
"response": [
{
- "description": "the domain ID of the affinity group",
- "name": "domainid",
+ "description": "the ID of the affinity group",
+ "name": "id",
"type": "string"
},
{
@@ -68991,11 +70499,6 @@
"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"
@@ -69006,13 +70509,13 @@
"type": "string"
},
{
- "description": "the account owning the affinity group",
- "name": "account",
+ "description": "the description of the affinity group",
+ "name": "description",
"type": "string"
},
{
- "description": "the ID of the affinity group",
- "name": "id",
+ "description": "the domain ID of the affinity group",
+ "name": "domainid",
"type": "string"
},
{
@@ -69021,6 +70524,11 @@
"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"
@@ -69029,389 +70537,37 @@
"type": "set"
},
{
- "description": "the ID of the disk offering of the virtual machine",
- "name": "diskofferingid",
+ "description": "the ID of the ISO attached to the virtual machine",
+ "name": "isoid",
"type": "string"
},
{
- "description": "State of the Service from LB rule",
- "name": "servicestate",
- "type": "string"
- },
- {
- "description": "list of security groups associated with the virtual machine",
- "name": "securitygroup",
- "response": [
- {
- "description": "the ID of the security group",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the project name of the group",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the domain ID of the security group",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the description of the security group",
- "name": "description",
- "type": "string"
- },
- {
- "description": "the name of the security group",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the list of egress rules associated with the security group",
- "name": "egressrule",
- "response": [
- {
- "description": "account owning the security group rule",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the 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 code for the ICMP message response",
- "name": "icmpcode",
- "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 CIDR notation for the base IP address of the security group rule",
- "name": "cidr",
- "type": "string"
- },
- {
- "description": "security group name",
- "name": "securitygroupname",
- "type": "string"
- },
- {
- "description": "the list of resource tags associated with the rule",
- "name": "tags",
- "response": [
- {
- "description": "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": "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"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- }
- ],
- "type": "set"
- }
- ],
- "type": "set"
- },
- {
- "description": "the domain name of the security group",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the list of virtualmachine ids associated with this securitygroup",
- "name": "virtualmachineids",
- "type": "set"
- },
- {
- "description": "the project id of the group",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the account owning the security group",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the list of resource tags associated with the rule",
- "name": "tags",
- "response": [
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "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": "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 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 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 id of the security group rule",
- "name": "ruleid",
- "type": "string"
- },
- {
- "description": "the list of resource tags associated with the rule",
- "name": "tags",
- "response": [
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "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 key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "security group name",
- "name": "securitygroupname",
- "type": "string"
- },
- {
- "description": "the starting IP of the security group rule",
- "name": "startport",
- "type": "integer"
- },
- {
- "description": "the type of the ICMP message response",
- "name": "icmptype",
- "type": "integer"
- }
- ],
- "type": "set"
- }
- ],
- "type": "set"
- },
- {
- "description": "Guest vm Boot Mode",
- "name": "bootmode",
- "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 project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
"description": "tag value",
"name": "value",
"type": "string"
},
{
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
"description": "customer associated with the tag",
"name": "customer",
"type": "string"
},
{
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
+ "description": "the domain associated with the tag",
+ "name": "domain",
"type": "string"
},
{
@@ -69425,8 +70581,13 @@
"type": "string"
},
{
- "description": "tag key name",
- "name": "key",
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
"type": "string"
},
{
@@ -69438,65 +70599,14 @@
"type": "set"
},
{
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "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": "OS type id of the vm",
- "name": "ostypeid",
- "type": "string"
- },
- {
- "description": "the name of the template for the virtual machine",
- "name": "templatename",
- "type": "string"
- },
- {
- "description": "the group name of the virtual machine",
- "name": "group",
- "type": "string"
- },
- {
- "description": "the ID of the virtual machine",
- "name": "id",
- "type": "string"
+ "description": "the number of cpu this virtual machine is running with",
+ "name": "cpunumber",
+ "type": "integer"
},
{
"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": "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 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"
}
]
},
@@ -69506,14 +70616,6 @@
"name": "upgradeRouterTemplate",
"params": [
{
- "description": "upgrades all routers within the specified zone",
- "length": 255,
- "name": "zoneid",
- "related": "createZone,updateZone,listZones,listZones",
- "required": false,
- "type": "uuid"
- },
- {
"description": "upgrades all routers owned by the specified account",
"length": 255,
"name": "account",
@@ -69521,10 +70623,10 @@
"type": "string"
},
{
- "description": "upgrades all routers within the specified cluster",
+ "description": "upgrades all routers within the specified zone",
"length": 255,
- "name": "clusterid",
- "related": "addCluster",
+ "name": "zoneid",
+ "related": "createZone,updateZone,listZones,listZones",
"required": false,
"type": "uuid"
},
@@ -69537,24 +70639,34 @@
"type": "uuid"
},
{
- "description": "upgrades all routers owned by the specified domain",
- "length": 255,
- "name": "domainid",
- "related": "listDomainChildren,listDomains",
- "required": false,
- "type": "uuid"
- },
- {
"description": "upgrades all routers within the specified pod",
"length": 255,
"name": "podid",
"related": "updatePod,createManagementNetworkIpRange",
"required": false,
"type": "uuid"
+ },
+ {
+ "description": "upgrades all routers within the specified cluster",
+ "length": 255,
+ "name": "clusterid",
+ "related": "addCluster",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "upgrades all routers owned by the specified domain",
+ "length": 255,
+ "name": "domainid",
+ "related": "listDomainChildren,listDomains",
+ "required": false,
+ "type": "uuid"
}
],
"related": "",
"response": [
+ {},
+ {},
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
@@ -69564,9 +70676,7 @@
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
- },
- {},
- {}
+ }
]
},
{
@@ -69586,345 +70696,173 @@
"related": "addHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost",
"response": [
{
- "description": "true if local storage is active, false otherwise",
- "name": "islocalstorageactive",
- "type": "boolean"
- },
- {
- "description": "the admin that annotated this host",
- "name": "username",
- "type": "string"
- },
- {},
- {
- "description": "the date and time the host was removed",
- "name": "removed",
- "type": "date"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "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": "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": "Video RAM for this vGPU type",
- "name": "videoram",
- "type": "long"
- },
- {
- "description": "Maximum displays per user",
- "name": "maxheads",
- "type": "long"
- },
- {
- "description": "Maximum Y resolution per display",
- "name": "maxresolutiony",
- "type": "long"
- },
- {
- "description": "Maximum vgpu can be created with this vgpu type on the given gpu group",
- "name": "maxcapacity",
- "type": "long"
- },
- {
- "description": "Maximum X resolution per display",
- "name": "maxresolutionx",
- "type": "long"
- },
- {
- "description": "Maximum no. of vgpu per gpu card (pgpu)",
- "name": "maxvgpuperpgpu",
- "type": "long"
- },
- {
- "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type",
- "name": "remainingcapacity",
- "type": "long"
- }
- ],
- "type": "list"
- }
- ],
- "type": "list"
- },
- {
- "description": "the date and time the host was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the cluster type of the cluster that host belongs to",
- "name": "clustertype",
- "type": "string"
- },
- {
- "description": "the number of CPU sockets on the host",
- "name": "cpusockets",
- "type": "integer"
- },
- {
- "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 Zone ID of the host",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the amount of the host's CPU currently allocated in MHz",
- "name": "cpuallocatedvalue",
- "type": "long"
- },
- {
- "description": "the amount of the host's CPU currently used",
- "name": "cpuused",
- "type": "string"
- },
- {
- "description": "the Pod name of the host",
- "name": "podname",
- "type": "string"
- },
- {
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "the amount of the host's memory currently allocated in percentage",
- "name": "memoryallocatedpercentage",
- "type": "string"
- },
- {
- "description": "the name of the host",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the total disk size of the host",
- "name": "disksizetotal",
- "type": "long"
- },
- {
"description": "the outgoing network traffic on the host",
"name": "networkkbswrite",
"type": "long"
},
{
- "description": "the host HA information information",
- "name": "hostha",
- "type": "hostharesponse"
- },
- {
- "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 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 Zone name of the host",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "the state of the host",
- "name": "state",
- "type": "status"
- },
- {
- "description": "the date and time the host was last pinged",
- "name": "lastpinged",
- "type": "date"
- },
- {
- "description": "Host details in key/value pairs.",
- "name": "details",
- "type": "map"
- },
- {
- "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor",
- "name": "cpuwithoverprovisioning",
- "type": "string"
- },
- {
- "description": "the amount of the host's CPU currently allocated in percentage",
- "name": "cpuallocatedpercentage",
- "type": "string"
- },
- {
- "description": "the hypervisor version",
- "name": "hypervisorversion",
- "type": "string"
- },
- {},
- {
- "description": "the host's currently allocated disk size",
- "name": "disksizeallocated",
- "type": "long"
- },
- {
- "description": "the amount of the host's memory after applying the mem.overprovisioning.factor",
- "name": "memorywithoverprovisioning",
- "type": "string"
- },
- {
- "description": "events available for the host",
- "name": "events",
- "type": "string"
- },
- {
- "description": "capabilities of the host",
- "name": "capabilities",
- "type": "string"
- },
- {
- "description": "the management server ID of the host",
- "name": "managementserverid",
- "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 tags for the host",
- "name": "hosttags",
- "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 amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor",
- "name": "cpuallocatedwithoverprovisioning",
- "type": "string"
- },
- {
"description": "the OS category name of the host",
"name": "oscategoryname",
"type": "string"
},
{
- "description": "the cluster name of the host",
- "name": "clustername",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "true if the host has capability to support UEFI boot",
- "name": "ueficapability",
- "type": "boolean"
- },
- {
- "description": "the amount of the host's memory currently allocated in bytes",
- "name": "memoryallocatedbytes",
- "type": "long"
- },
- {
- "description": "true if the host is disconnected. False otherwise.",
- "name": "disconnected",
- "type": "date"
- },
- {
- "description": "the amount of the host's CPU currently allocated",
- "name": "cpuallocated",
- "type": "string"
- },
- {
- "description": "the host type",
- "name": "type",
- "type": "type"
- },
- {
- "description": "the host hypervisor",
- "name": "hypervisor",
- "type": "hypervisortype"
- },
- {
- "description": "the OS category ID of the host",
- "name": "oscategoryid",
- "type": "string"
- },
- {
- "description": "the Pod ID of the host",
- "name": "podid",
- "type": "string"
- },
- {
"description": "the IP address of the host",
"name": "ipaddress",
"type": "string"
},
{
+ "description": "the cluster name of the host",
+ "name": "clustername",
+ "type": "string"
+ },
+ {
+ "description": "the management server ID of the host",
+ "name": "managementserverid",
+ "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 amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor",
+ "name": "cpuallocatedwithoverprovisioning",
+ "type": "string"
+ },
+ {
+ "description": "GPU cards present in the host",
+ "name": "gpugroup",
+ "response": [
+ {
+ "description": "the list of enabled vGPUs",
+ "name": "vgpu",
+ "response": [
+ {
+ "description": "Maximum Y resolution per display",
+ "name": "maxresolutiony",
+ "type": "long"
+ },
+ {
+ "description": "Maximum X resolution per display",
+ "name": "maxresolutionx",
+ "type": "long"
+ },
+ {
+ "description": "Video RAM for this vGPU type",
+ "name": "videoram",
+ "type": "long"
+ },
+ {
+ "description": "Maximum no. of vgpu per gpu card (pgpu)",
+ "name": "maxvgpuperpgpu",
+ "type": "long"
+ },
+ {
+ "description": "Model Name of vGPU",
+ "name": "vgputype",
+ "type": "string"
+ },
+ {
+ "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type",
+ "name": "remainingcapacity",
+ "type": "long"
+ },
+ {
+ "description": "Maximum vgpu can be created with this vgpu type on the given gpu group",
+ "name": "maxcapacity",
+ "type": "long"
+ },
+ {
+ "description": "Maximum displays per user",
+ "name": "maxheads",
+ "type": "long"
+ }
+ ],
+ "type": "list"
+ },
+ {
+ "description": "GPU cards present in the host",
+ "name": "gpugroupname",
+ "type": "string"
+ }
+ ],
+ "type": "list"
+ },
+ {
+ "description": "the name of the host",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise",
+ "name": "suitableformigration",
+ "type": "boolean"
+ },
+ {
+ "description": "the cluster type of the cluster that host belongs to",
+ "name": "clustertype",
+ "type": "string"
+ },
+ {
+ "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",
+ "type": "string"
+ },
+ {
+ "description": "the resource state of the host",
+ "name": "resourcestate",
+ "type": "string"
+ },
+ {
+ "description": "the incoming network traffic on the host",
+ "name": "networkkbsread",
+ "type": "long"
+ },
+ {
+ "description": "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": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise",
+ "name": "hahost",
+ "type": "boolean"
+ },
+ {
+ "description": "events available for the host",
+ "name": "events",
+ "type": "string"
+ },
+ {
+ "description": "true if local storage is active, false otherwise",
+ "name": "islocalstorageactive",
+ "type": "boolean"
+ },
+ {
+ "description": "the ID of the host",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the state of the host",
+ "name": "state",
+ "type": "status"
+ },
+ {
+ "description": "the Zone name of the host",
+ "name": "zonename",
+ "type": "string"
},
{
"description": "the amount of the host's memory currently allocated",
@@ -69932,9 +70870,166 @@
"type": "long"
},
{
- "description": "the cpu average load on the host",
- "name": "cpuloadaverage",
- "type": "double"
+ "description": "the Pod name of the host",
+ "name": "podname",
+ "type": "string"
+ },
+ {
+ "description": "the last annotation set on this host by an admin",
+ "name": "annotation",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the amount of the host's memory currently used",
+ "name": "memoryused",
+ "type": "long"
+ },
+ {
+ "description": "the host hypervisor",
+ "name": "hypervisor",
+ "type": "hypervisortype"
+ },
+ {
+ "description": "the amount of the host's CPU currently allocated in percentage",
+ "name": "cpuallocatedpercentage",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the host's memory after applying the mem.overprovisioning.factor",
+ "name": "memorywithoverprovisioning",
+ "type": "string"
+ },
+ {
+ "description": "the date and time the host was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the amount of the host's CPU currently allocated",
+ "name": "cpuallocated",
+ "type": "string"
+ },
+ {
+ "description": "the last time this host was annotated",
+ "name": "lastannotated",
+ "type": "date"
+ },
+ {
+ "description": "the amount of the host's CPU currently allocated in MHz",
+ "name": "cpuallocatedvalue",
+ "type": "long"
+ },
+ {
+ "description": "the admin that annotated this host",
+ "name": "username",
+ "type": "string"
+ },
+ {
+ "description": "true if the host is disconnected. False otherwise.",
+ "name": "disconnected",
+ "type": "date"
+ },
+ {
+ "description": "the host's currently allocated disk size",
+ "name": "disksizeallocated",
+ "type": "long"
+ },
+ {
+ "description": "the host HA information information",
+ "name": "hostha",
+ "type": "hostharesponse"
+ },
+ {},
+ {
+ "description": "the host type",
+ "name": "type",
+ "type": "type"
+ },
+ {
+ "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 cluster ID of the host",
+ "name": "clusterid",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the amount of the host's memory currently allocated in percentage",
+ "name": "memoryallocatedpercentage",
+ "type": "string"
+ },
+ {
+ "description": "the CPU number of the host",
+ "name": "cpunumber",
+ "type": "integer"
+ },
+ {
+ "description": "comma-separated list of tags for the host",
+ "name": "hosttags",
+ "type": "string"
+ },
+ {
+ "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning",
+ "name": "memorytotal",
+ "type": "long"
+ },
+ {
+ "description": "the date and time the host was removed",
+ "name": "removed",
+ "type": "date"
+ },
+ {
+ "description": "capabilities of the host",
+ "name": "capabilities",
+ "type": "string"
+ },
+ {
+ "description": "the total disk size of the host",
+ "name": "disksizetotal",
+ "type": "long"
+ },
+ {
+ "description": "the OS category ID of the host",
+ "name": "oscategoryid",
+ "type": "string"
+ },
+ {
+ "description": "the 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": "Host details in key/value pairs.",
+ "name": "details",
+ "type": "map"
+ },
+ {
+ "description": "the host version",
+ "name": "version",
+ "type": "string"
+ },
+ {
+ "description": "the date and time the host was last pinged",
+ "name": "lastpinged",
+ "type": "date"
},
{
"description": "the host out-of-band management information",
@@ -69942,8 +71037,23 @@
"type": "outofbandmanagementresponse"
},
{
- "description": "the host version",
- "name": "version",
+ "description": "the hypervisor version",
+ "name": "hypervisorversion",
+ "type": "string"
+ },
+ {
+ "description": "the cpu average load on the host",
+ "name": "cpuloadaverage",
+ "type": "double"
+ },
+ {
+ "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor",
+ "name": "cpuwithoverprovisioning",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the host's CPU currently used",
+ "name": "cpuused",
"type": "string"
}
]
@@ -69961,6 +71071,27 @@
"type": "string"
},
{
+ "description": "the account with which the VLAN IP range is associated. Must be used with the domainId parameter.",
+ "length": 255,
+ "name": "account",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
"description": "the ID of the VLAN IP range",
"length": 255,
"name": "id",
@@ -69969,10 +71100,10 @@
"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": "physical network id of the VLAN IP range",
"length": 255,
- "name": "domainid",
- "related": "listDomainChildren,listDomains",
+ "name": "physicalnetworkid",
+ "related": "createPhysicalNetwork",
"required": false,
"type": "uuid"
},
@@ -69985,57 +71116,14 @@
"type": "uuid"
},
{
- "description": "",
+ "description": "project who will own the VLAN",
"length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
- },
- {
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
- },
- {
- "description": "the Zone ID of the VLAN IP range",
- "length": 255,
- "name": "zoneid",
- "related": "createZone,updateZone,listZones,listZones",
+ "name": "projectid",
+ "related": "listProjectAccounts,activateProject,suspendProject,updateProject",
"required": false,
"type": "uuid"
},
{
- "description": "",
- "length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
- },
- {
- "description": "true if VLAN is of Virtual type, false if Direct",
- "length": 255,
- "name": "forvirtualnetwork",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "physical network id of the VLAN IP range",
- "length": 255,
- "name": "physicalnetworkid",
- "related": "createPhysicalNetwork",
- "required": false,
- "type": "uuid"
- },
- {
- "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": "the Pod ID of the VLAN IP range",
"length": 255,
"name": "podid",
@@ -70044,75 +71132,41 @@
"type": "uuid"
},
{
- "description": "project who will own the VLAN",
+ "description": "List by keyword",
"length": 255,
- "name": "projectid",
- "related": "listProjectAccounts,activateProject,suspendProject,updateProject",
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the domain ID with which the VLAN IP range is associated. If used with the account parameter, returns all VLAN IP ranges for that account in the specified domain.",
+ "length": 255,
+ "name": "domainid",
+ "related": "listDomainChildren,listDomains",
"required": false,
"type": "uuid"
+ },
+ {
+ "description": "the Zone ID of the VLAN IP range",
+ "length": 255,
+ "name": "zoneid",
+ "related": "createZone,updateZone,listZones,listZones",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "true if VLAN is of Virtual type, false if Direct",
+ "length": 255,
+ "name": "forvirtualnetwork",
+ "required": false,
+ "type": "boolean"
}
],
"related": "updateVlanIpRange,dedicatePublicIpRange",
"response": [
{
- "description": "the domain ID of the VLAN IP range",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the Pod ID for the VLAN IP range",
- "name": "podid",
- "type": "string"
- },
- {
- "description": "the ID of the VLAN IP range",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the Zone ID of the VLAN IP range",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the end ipv6 of the VLAN IP range",
- "name": "endipv6",
- "type": "string"
- },
- {
- "description": "the start ipv6 of the VLAN IP range",
- "name": "startipv6",
- "type": "string"
- },
- {
- "description": "the start ip of the VLAN IP range",
- "name": "startip",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the description of the VLAN IP range",
- "name": "description",
- "type": "string"
- },
- {
- "description": "the cidr of IPv6 network",
- "name": "ip6cidr",
- "type": "string"
- },
- {
- "description": "the virtual network for the VLAN IP range",
- "name": "forvirtualnetwork",
- "type": "boolean"
- },
- {},
- {
- "description": "the end ip of the VLAN IP range",
- "name": "endip",
+ "description": "the gateway of the VLAN IP range",
+ "name": "gateway",
"type": "string"
},
{
@@ -70120,35 +71174,14 @@
"name": "ip6gateway",
"type": "string"
},
- {},
{
- "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 Pod name for the VLAN IP range",
- "name": "podname",
- "type": "string"
- },
- {
- "description": "indicates whether VLAN IP range is dedicated to system vms or not",
- "name": "forsystemvms",
- "type": "boolean"
- },
- {
- "description": "the network id of vlan range",
- "name": "networkid",
- "type": "string"
- },
- {
- "description": "the account of the VLAN IP range",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the project id of the vlan range",
- "name": "projectid",
+ "description": "the physical network this belongs to",
+ "name": "physicalnetworkid",
"type": "string"
},
{
@@ -70157,13 +71190,65 @@
"type": "integer"
},
{
- "description": "the domain name of the VLAN IP range",
- "name": "domain",
+ "description": "the virtual network for the VLAN IP range",
+ "name": "forvirtualnetwork",
+ "type": "boolean"
+ },
+ {
+ "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 UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the cidr of IPv6 network",
+ "name": "ip6cidr",
+ "type": "string"
+ },
+ {
+ "description": "indicates whether VLAN IP range is dedicated to system vms or not",
+ "name": "forsystemvms",
+ "type": "boolean"
+ },
+ {
+ "description": "the domain ID of the VLAN IP range",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the start ip of the VLAN IP range",
+ "name": "startip",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the ID of the VLAN IP range",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the netmask of the VLAN IP range",
+ "name": "netmask",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the Zone ID of the VLAN IP range",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the description of the VLAN IP range",
+ "name": "description",
+ "type": "string"
+ },
+ {
+ "description": "the account of the VLAN IP range",
+ "name": "account",
"type": "string"
},
{
@@ -70172,13 +71257,38 @@
"type": "string"
},
{
+ "description": "the end ip of the VLAN IP range",
+ "name": "endip",
+ "type": "string"
+ },
+ {
+ "description": "the network id of vlan range",
+ "name": "networkid",
+ "type": "string"
+ },
+ {
+ "description": "the end ipv6 of the VLAN IP range",
+ "name": "endipv6",
+ "type": "string"
+ },
+ {
+ "description": "the project id of the vlan range",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the Pod name for the VLAN IP range",
+ "name": "podname",
+ "type": "string"
+ },
+ {
"description": "the project name of the vlan range",
"name": "project",
"type": "string"
},
{
- "description": "the physical network this belongs to",
- "name": "physicalnetworkid",
+ "description": "the start ipv6 of the VLAN IP range",
+ "name": "startipv6",
"type": "string"
}
]
@@ -70189,6 +71299,84 @@
"name": "updateZone",
"params": [
{
+ "description": "the ID of the Zone",
+ "length": 255,
+ "name": "id",
+ "related": "createZone,updateZone,listZones,listZones",
+ "required": true,
+ "type": "uuid"
+ },
+ {
+ "description": "the dhcp Provider for the Zone",
+ "length": 255,
+ "name": "dhcpprovider",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the second DNS for IPv6 network in the Zone",
+ "length": 255,
+ "name": "ip6dns2",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the details for the Zone",
+ "length": 255,
+ "name": "details",
+ "required": false,
+ "type": "map"
+ },
+ {
+ "description": "the name of the Zone",
+ "length": 255,
+ "name": "name",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "Allocation state of this cluster for allocation of new resources",
+ "length": 255,
+ "name": "allocationstate",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the first internal DNS for the Zone",
+ "length": 255,
+ "name": "internaldns1",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the second internal DNS for the Zone",
+ "length": 255,
+ "name": "internaldns2",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "Network domain name for the networks in the zone; empty string will update domain with NULL value",
+ "length": 255,
+ "name": "domain",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the first DNS for the Zone",
+ "length": 255,
+ "name": "dns1",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "sort key of the zone, integer",
+ "length": 255,
+ "name": "sortkey",
+ "required": false,
+ "type": "integer"
+ },
+ {
"description": "the first DNS for IPv6 network in the Zone",
"length": 255,
"name": "ip6dns1",
@@ -70203,63 +71391,6 @@
"type": "string"
},
{
- "description": "true if local storage offering enabled, false otherwise",
- "length": 255,
- "name": "localstorageenabled",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "the details for the Zone",
- "length": 255,
- "name": "details",
- "required": false,
- "type": "map"
- },
- {
- "description": "the ID of the Zone",
- "length": 255,
- "name": "id",
- "related": "createZone,updateZone,listZones,listZones",
- "required": true,
- "type": "uuid"
- },
- {
- "description": "the second internal DNS for the Zone",
- "length": 255,
- "name": "internaldns2",
- "required": false,
- "type": "string"
- },
- {
- "description": "updates a private zone to public if set, but not vice-versa",
- "length": 255,
- "name": "ispublic",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "Allocation state of this cluster for allocation of new resources",
- "length": 255,
- "name": "allocationstate",
- "required": false,
- "type": "string"
- },
- {
- "description": "the dhcp Provider for the Zone",
- "length": 255,
- "name": "dhcpprovider",
- "required": false,
- "type": "string"
- },
- {
- "description": "the first DNS for the Zone",
- "length": 255,
- "name": "dns1",
- "required": false,
- "type": "string"
- },
- {
"description": "the second DNS for the Zone",
"length": 255,
"name": "dns2",
@@ -70267,11 +71398,11 @@
"type": "string"
},
{
- "description": "the name of the Zone",
+ "description": "true if local storage offering enabled, false otherwise",
"length": 255,
- "name": "name",
+ "name": "localstorageenabled",
"required": false,
- "type": "string"
+ "type": "boolean"
},
{
"description": "the dns search order list",
@@ -70281,49 +71412,28 @@
"type": "list"
},
{
- "description": "Network domain name for the networks in the zone; empty string will update domain with NULL value",
+ "description": "updates a private zone to public if set, but not vice-versa",
"length": 255,
- "name": "domain",
+ "name": "ispublic",
"required": false,
- "type": "string"
- },
- {
- "description": "the second DNS for IPv6 network in the Zone",
- "length": 255,
- "name": "ip6dns2",
- "required": false,
- "type": "string"
- },
- {
- "description": "sort key of the zone, integer",
- "length": 255,
- "name": "sortkey",
- "required": false,
- "type": "integer"
- },
- {
- "description": "the first internal DNS for the Zone",
- "length": 255,
- "name": "internaldns1",
- "required": false,
- "type": "string"
+ "type": "boolean"
}
],
"related": "createZone,listZones,listZones",
"response": [
{
+ "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": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
- },
- {
- "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"
},
{
@@ -70332,29 +71442,8 @@
"type": "string"
},
{
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "the display text of the zone",
- "name": "displaytext",
- "type": "string"
- },
- {},
- {
- "description": "the UUID of the containing domain, null for public zones",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "true if security groups support is enabled, false otherwise",
- "name": "securitygroupsenabled",
- "type": "boolean"
- },
- {
- "description": "Network domain name for the networks in the zone",
- "name": "domain",
+ "description": "the second IPv6 DNS for the Zone",
+ "name": "ip6dns2",
"type": "string"
},
{},
@@ -70364,165 +71453,58 @@
"type": "string"
},
{
- "description": "the network type of the zone; can be Basic or Advanced",
- "name": "networktype",
+ "description": "Zone Token",
+ "name": "zonetoken",
"type": "string"
},
{
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "description": "true if security groups support is enabled, false otherwise",
+ "name": "securitygroupsenabled",
+ "type": "boolean"
+ },
+ {
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
{
+ "description": "the UUID of the containing domain, null for public zones",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
"description": "the dhcp Provider for the Zone",
"name": "dhcpprovider",
"type": "string"
},
{
- "description": "Zone description",
- "name": "description",
- "type": "string"
- },
- {
- "description": "Zone Token",
- "name": "zonetoken",
- "type": "string"
- },
- {
- "description": "the list of resource tags associated with zone.",
- "name": "tags",
- "response": [
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the 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 key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "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": "Zone id",
- "name": "id",
- "type": "string"
- },
- {
- "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 first DNS for the Zone",
- "name": "dns1",
- "type": "string"
- },
- {
- "description": "the second IPv6 DNS for the Zone",
- "name": "ip6dns2",
- "type": "string"
- },
- {
- "description": "the second DNS for the Zone",
- "name": "dns2",
- "type": "string"
- },
- {
- "description": "Zone name",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the first internal DNS for the Zone",
- "name": "internaldns1",
- "type": "string"
- },
- {
- "description": "true if local storage offering enabled, false otherwise",
- "name": "localstorageenabled",
- "type": "boolean"
- },
- {
"description": "the capacity of the Zone",
"name": "capacity",
"response": [
{
- "description": "the Cluster name",
- "name": "clustername",
- "type": "string"
- },
- {
- "description": "the total capacity available",
- "name": "capacitytotal",
+ "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 Cluster ID",
- "name": "clusterid",
- "type": "string"
+ "description": "the total capacity available",
+ "name": "capacitytotal",
+ "type": "long"
},
{
- "description": "the capacity currently in allocated",
- "name": "capacityallocated",
- "type": "long"
+ "description": "the capacity name",
+ "name": "name",
+ "type": "string"
},
{
"description": "the Pod ID",
@@ -70530,13 +71512,13 @@
"type": "string"
},
{
- "description": "the capacity currently in use",
- "name": "capacityused",
- "type": "long"
+ "description": "the Cluster name",
+ "name": "clustername",
+ "type": "string"
},
{
- "description": "the capacity name",
- "name": "name",
+ "description": "the Pod name",
+ "name": "podname",
"type": "string"
},
{
@@ -70553,13 +71535,141 @@
"description": "the Zone name",
"name": "zonename",
"type": "string"
+ },
+ {
+ "description": "the Cluster ID",
+ "name": "clusterid",
+ "type": "string"
+ },
+ {
+ "description": "the capacity currently in allocated",
+ "name": "capacityallocated",
+ "type": "long"
}
],
"type": "list"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the first DNS for the Zone",
+ "name": "dns1",
+ "type": "string"
+ },
+ {
+ "description": "the second DNS for the Zone",
+ "name": "dns2",
+ "type": "string"
+ },
+ {
+ "description": "Meta data associated with the zone (key/value pairs)",
+ "name": "resourcedetails",
+ "type": "map"
+ },
+ {
+ "description": "Network domain name for the networks in the zone",
+ "name": "domain",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the list of resource tags associated with zone.",
+ "name": "tags",
+ "response": [
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "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"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the first internal DNS for the Zone",
+ "name": "internaldns1",
+ "type": "string"
+ },
+ {
+ "description": "the name of the containing domain, null for public zones",
+ "name": "domainname",
+ "type": "string"
+ },
+ {
+ "description": "Zone name",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "Zone description",
+ "name": "description",
+ "type": "string"
+ },
+ {
+ "description": "true if local storage offering enabled, false otherwise",
+ "name": "localstorageenabled",
+ "type": "boolean"
+ },
+ {
+ "description": "the network type of the zone; can be Basic or Advanced",
+ "name": "networktype",
+ "type": "string"
+ },
+ {
+ "description": "the display text of the zone",
+ "name": "displaytext",
+ "type": "string"
+ },
+ {
+ "description": "Zone id",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the guest CIDR address for the Zone",
+ "name": "guestcidraddress",
"type": "string"
}
]
@@ -70577,6 +71687,14 @@
"type": "string"
},
{
+ "description": "the ID of the volume",
+ "length": 255,
+ "name": "id",
+ "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume",
+ "required": true,
+ "type": "uuid"
+ },
+ {
"description": "the url to which the volume would be extracted",
"length": 2048,
"name": "url",
@@ -70590,37 +71708,19 @@
"related": "createZone,listZones,listZones",
"required": true,
"type": "uuid"
- },
- {
- "description": "the ID of the volume",
- "length": 255,
- "name": "id",
- "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume",
- "required": true,
- "type": "uuid"
}
],
"related": "extractTemplate",
"response": [
- {
- "description": "zone name the object was extracted from",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "the percentage of the entity uploaded to the specified location",
- "name": "uploadpercentage",
- "type": "integer"
- },
- {
- "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded",
- "name": "url",
- "type": "string"
- },
{},
{
- "description": "the state of the extracted object",
- "name": "state",
+ "description": "the id of extracted object",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the status of the extraction",
+ "name": "status",
"type": "string"
},
{
@@ -70629,27 +71729,6 @@
"type": "string"
},
{
- "description": "the account id to which the extracted object belongs",
- "name": "accountid",
- "type": "string"
- },
- {
- "description": "type of the storage",
- "name": "storagetype",
- "type": "string"
- },
- {
- "description": "",
- "name": "resultstring",
- "type": "string"
- },
- {
- "description": "the upload id of extracted object",
- "name": "extractId",
- "type": "string"
- },
- {},
- {
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
@@ -70659,9 +71738,10 @@
"name": "created",
"type": "date"
},
+ {},
{
- "description": "the status of the extraction",
- "name": "status",
+ "description": "the account id to which the extracted object belongs",
+ "name": "accountid",
"type": "string"
},
{
@@ -70670,18 +71750,48 @@
"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": "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",
"type": "string"
},
{
+ "description": "",
+ "name": "resultstring",
+ "type": "string"
+ },
+ {
"description": "zone ID the object was extracted from",
"name": "zoneid",
"type": "string"
},
{
- "description": "the id of extracted object",
- "name": "id",
+ "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": "the upload id of extracted object",
+ "name": "extractId",
+ "type": "string"
+ },
+ {
+ "description": "the state of the extracted object",
+ "name": "state",
"type": "string"
}
]
@@ -70692,6 +71802,21 @@
"name": "listProjectAccounts",
"params": [
{
+ "description": "ID of the project",
+ "length": 255,
+ "name": "projectid",
+ "related": "listProjectAccounts,activateProject,suspendProject,updateProject",
+ "required": true,
+ "type": "uuid"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
"description": "list invitation by user ID",
"length": 255,
"name": "userid",
@@ -70700,6 +71825,13 @@
"type": "uuid"
},
{
+ "description": "list accounts of the project by account name",
+ "length": 255,
+ "name": "account",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "List by keyword",
"length": 255,
"name": "keyword",
@@ -70727,193 +71859,50 @@
"name": "role",
"required": false,
"type": "string"
- },
- {
- "description": "list accounts of the project by account name",
- "length": 255,
- "name": "account",
- "required": false,
- "type": "string"
- },
- {
- "description": "",
- "length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
- },
- {
- "description": "ID of the project",
- "length": 255,
- "name": "projectid",
- "related": "listProjectAccounts,activateProject,suspendProject,updateProject",
- "required": true,
- "type": "uuid"
}
],
"related": "activateProject,suspendProject,updateProject",
"response": [
{
- "description": "the total number of vpcs the project can own",
- "name": "vpclimit",
+ "description": "the total number of templates available to be created by this project",
+ "name": "templateavailable",
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the project account name of the project",
- "name": "projectaccountname",
- "type": "string"
- },
- {
- "description": "the domain id the project belongs to",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the total number of templates which have been created by this project",
- "name": "templatetotal",
- "type": "long"
- },
- {
- "description": "the date this project was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the total secondary storage space (in GiB) owned by project",
- "name": "secondarystoragetotal",
- "type": "float"
- },
- {
- "description": "the total primary storage space (in GiB) the project can own",
- "name": "primarystoragelimit",
- "type": "string"
- },
- {
- "description": "the name of the project",
- "name": "name",
- "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"
},
{
- "description": "the total volume being used by this project",
- "name": "volumetotal",
- "type": "long"
- },
- {
- "description": "the total memory (in MB) owned by project",
- "name": "memorytotal",
- "type": "long"
- },
- {
- "description": "the total number of public ip addresses available for this project to acquire",
- "name": "ipavailable",
- "type": "string"
- },
- {
- "description": "the domain name where the project belongs to",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the total number of virtual machines stopped for this project",
- "name": "vmstopped",
- "type": "integer"
- },
- {
- "description": "the total number of virtual machines that can be deployed by this project",
- "name": "vmlimit",
- "type": "string"
- },
- {
- "description": "the account name of the project's owners",
- "name": "owner",
- "type": "list"
- },
- {
- "description": "the total number of snapshots which can be stored by this project",
- "name": "snapshotlimit",
- "type": "string"
- },
- {
- "description": "the total memory (in MB) the project can own",
- "name": "memorylimit",
- "type": "string"
- },
- {
- "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 project can acquire",
- "name": "iplimit",
- "type": "string"
- },
- {
- "description": "the total number of cpu cores the project can own",
- "name": "cpulimit",
- "type": "string"
- },
- {
- "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) available to be used for this project",
- "name": "primarystorageavailable",
- "type": "string"
- },
- {
- "description": "the total number of networks available to be created for this project",
- "name": "networkavailable",
- "type": "string"
- },
- {
- "description": "the state of the project",
- "name": "state",
- "type": "string"
- },
- {
- "description": "the total number of networks owned by project",
- "name": "networktotal",
- "type": "long"
- },
- {
- "description": "the id of the project",
- "name": "id",
- "type": "string"
- },
- {},
- {
- "description": "the total volume available for this project",
- "name": "volumeavailable",
- "type": "string"
- },
- {
"description": "the list of resource tags associated with vm",
"name": "tags",
"response": [
{
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
"description": "resource type",
"name": "resourcetype",
"type": "string"
},
{
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
"description": "customer associated with the tag",
"name": "customer",
"type": "string"
@@ -70924,8 +71913,8 @@
"type": "string"
},
{
- "description": "tag key name",
- "name": "key",
+ "description": "tag value",
+ "name": "value",
"type": "string"
},
{
@@ -70934,104 +71923,14 @@
"type": "string"
},
{
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "tag 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"
}
],
"type": "list"
},
{
- "description": "the total number of vpcs available to be created for this project",
- "name": "vpcavailable",
- "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) the project can own",
- "name": "secondarystoragelimit",
- "type": "string"
- },
- {
- "description": "the total volume which can be used by this project",
- "name": "volumelimit",
- "type": "string"
- },
- {
- "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",
- "type": "string"
- },
- {
- "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 total number of snapshots available for this project",
- "name": "snapshotavailable",
- "type": "string"
- },
- {
- "description": "the total number of cpu cores owned by project",
- "name": "cputotal",
- "type": "long"
- },
- {
- "description": "the total number of virtual machines available for this project to acquire",
- "name": "vmavailable",
- "type": "string"
- },
- {
- "description": "the total primary storage space (in GiB) owned by project",
- "name": "primarystoragetotal",
- "type": "long"
- },
- {
- "description": "the total number of templates which can be created by this project",
- "name": "templatelimit",
- "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 deployed by this project",
"name": "vmtotal",
"type": "long"
@@ -71041,11 +71940,222 @@
"name": "icon",
"type": "resourceiconresponse"
},
- {},
+ {
+ "description": "the total number of public ip addresses this project can acquire",
+ "name": "iplimit",
+ "type": "string"
+ },
+ {
+ "description": "the account name of the project's owners",
+ "name": "owner",
+ "type": "list"
+ },
+ {
+ "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 networks owned by project",
+ "name": "networktotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of networks the project can own",
+ "name": "networklimit",
+ "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",
+ "name": "vmstopped",
+ "type": "integer"
+ },
+ {
+ "description": "the id of the project",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the domain name where the project belongs to",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the total number of public ip addresses allocated for this project",
+ "name": "iptotal",
+ "type": "long"
+ },
+ {
+ "description": "the 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 primary storage space (in GiB) available to be used for this project",
+ "name": "primarystorageavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of templates which can be created by this project",
+ "name": "templatelimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of cpu cores available to be created for this project",
+ "name": "cpuavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total volume available for this project",
+ "name": "volumeavailable",
+ "type": "string"
+ },
+ {
+ "description": "the state of the project",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "the total number of virtual machines that can be deployed by this project",
+ "name": "vmlimit",
+ "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) 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) owned by project",
+ "name": "memorytotal",
+ "type": "long"
+ },
+ {
+ "description": "the total primary storage space (in GiB) the project can own",
+ "name": "primarystoragelimit",
+ "type": "string"
+ },
+ {
+ "description": "the total secondary storage space (in GiB) the project can own",
+ "name": "secondarystoragelimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of snapshots available for this project",
+ "name": "snapshotavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of snapshots which can be stored by this project",
+ "name": "snapshotlimit",
+ "type": "string"
+ },
+ {
+ "description": "the date this project was created",
+ "name": "created",
+ "type": "date"
+ },
+ {},
+ {
+ "description": "the total number of public ip addresses available for this project to acquire",
+ "name": "ipavailable",
+ "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 owned by project",
+ "name": "cputotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of vpcs available to be created for this project",
+ "name": "vpcavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of vpcs the project can own",
+ "name": "vpclimit",
+ "type": "string"
+ },
+ {
+ "description": "the name of the project",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the total volume being used by this project",
+ "name": "volumetotal",
+ "type": "long"
+ },
+ {
+ "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 memory (in MB) available to be created for this project",
+ "name": "memoryavailable",
+ "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 project account name of the project",
+ "name": "projectaccountname",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the total number of snapshots stored by this project",
+ "name": "snapshottotal",
+ "type": "long"
+ },
+ {
+ "description": "the total volume which can be used by this project",
+ "name": "volumelimit",
+ "type": "string"
}
],
"since": "3.0.0"
@@ -71056,6 +72166,14 @@
"name": "addExternalLoadBalancer",
"params": [
{
+ "description": "Zone in which to add the external load balancer appliance.",
+ "length": 255,
+ "name": "zoneid",
+ "related": "createZone,listZones,listZones",
+ "required": true,
+ "type": "uuid"
+ },
+ {
"description": "Username of the external load balancer appliance.",
"length": 255,
"name": "username",
@@ -71063,70 +72181,42 @@
"type": "string"
},
{
+ "description": "Password of the external load balancer appliance.",
+ "length": 255,
+ "name": "password",
+ "required": true,
+ "type": "string"
+ },
+ {
"description": "URL of the external load balancer appliance.",
"length": 255,
"name": "url",
"required": true,
"type": "string"
- },
- {
- "description": "Zone in which to add the external load balancer appliance.",
- "length": 255,
- "name": "zoneid",
- "related": "createZone,listZones,listZones",
- "required": true,
- "type": "uuid"
- },
- {
- "description": "Password of the external load balancer appliance.",
- "length": 255,
- "name": "password",
- "required": true,
- "type": "string"
}
],
"related": "",
"response": [
- {
- "description": "the private interface of the external load balancer",
- "name": "privateinterface",
- "type": "string"
- },
- {
- "description": "the ID of the network device",
- "name": "id",
- "type": "string"
- },
+ {},
+ {},
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
{
- "description": "the ID of the external load balancer",
- "name": "id",
- "type": "string"
- },
- {},
- {
- "description": "the management IP address of the external load balancer",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "description": "the number of times to retry requests to the external load balancer",
- "name": "numretries",
- "type": "string"
- },
- {},
- {
"description": "the zone ID of the external load balancer",
"name": "zoneid",
"type": "string"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the private interface of the external load balancer",
+ "name": "privateinterface",
+ "type": "string"
+ },
+ {
+ "description": "the management IP address of the external load balancer",
+ "name": "ipaddress",
"type": "string"
},
{
@@ -71135,9 +72225,29 @@
"type": "string"
},
{
+ "description": "the ID of the external load balancer",
+ "name": "id",
+ "type": "string"
+ },
+ {
"description": "the username that's used to log in to the external load balancer",
"name": "username",
"type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the network device",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the number of times to retry requests to the external load balancer",
+ "name": "numretries",
+ "type": "string"
}
]
},
@@ -71147,6 +72257,13 @@
"name": "updateAutoScalePolicy",
"params": [
{
+ "description": "the duration for which the conditions have to be true before action is taken",
+ "length": 255,
+ "name": "duration",
+ "required": false,
+ "type": "integer"
+ },
+ {
"description": "the list of IDs of the conditions that are being evaluated on every interval",
"length": 255,
"name": "conditionids",
@@ -71155,38 +72272,56 @@
"type": "list"
},
{
- "description": "the cool down period for which the policy should not be evaluated after the action has been taken",
- "length": 255,
- "name": "quiettime",
- "required": false,
- "type": "integer"
- },
- {
- "description": "the duration for which the conditions have to be true before action is taken",
- "length": 255,
- "name": "duration",
- "required": false,
- "type": "integer"
- },
- {
"description": "the ID of the autoscale policy",
"length": 255,
"name": "id",
"related": "listAutoScalePolicies,updateAutoScalePolicy",
"required": true,
"type": "uuid"
+ },
+ {
+ "description": "the cool down period for which the policy should not be evaluated after the action has been taken",
+ "length": 255,
+ "name": "quiettime",
+ "required": false,
+ "type": "integer"
}
],
"related": "listAutoScalePolicies",
"response": [
{
+ "description": "the account owning the autoscale policy",
+ "name": "account",
+ "type": "string"
+ },
+ {
"description": "the list of IDs of the conditions that are being evaluated on every interval",
"name": "conditions",
"type": "list"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
+ "description": "the project name of the autoscale policy",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the action to be executed if all the conditions evaluate to true for the specified duration.",
+ "name": "action",
+ "type": "string"
+ },
+ {
+ "description": "the 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 duration for which the conditions have to be true before action is taken",
+ "name": "duration",
"type": "integer"
},
{
@@ -71194,11 +72329,7 @@
"name": "jobid",
"type": "string"
},
- {
- "description": "the project name of the autoscale policy",
- "name": "project",
- "type": "string"
- },
+ {},
{},
{
"description": "the autoscale policy ID",
@@ -71206,40 +72337,19 @@
"type": "string"
},
{
- "description": "the account owning the autoscale policy",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the domain name of the autoscale policy",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the cool down period for which the policy should not be evaluated after the action has been taken",
- "name": "quiettime",
- "type": "integer"
- },
- {},
- {
- "description": "the 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": "the project id autoscale policy",
"name": "projectid",
"type": "string"
},
{
- "description": "the domain ID of the autoscale policy",
- "name": "domainid",
+ "description": "the domain name of the autoscale policy",
+ "name": "domain",
"type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
}
]
},
@@ -71249,6 +72359,88 @@
"name": "createDiskOffering",
"params": [
{
+ "description": "burst requests read rate of the disk offering",
+ "length": 255,
+ "name": "iopsreadratemax",
+ "required": false,
+ "type": "long"
+ },
+ {
+ "description": "whether disk offering size is custom or not",
+ "length": 255,
+ "name": "customized",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "the ID of the containing domain(s), null for public offerings",
+ "length": 255,
+ "name": "domainid",
+ "related": "listDomainChildren,listDomains",
+ "required": false,
+ "type": "list"
+ },
+ {
+ "description": "whether disk offering iops is custom or not",
+ "length": 255,
+ "name": "customizediops",
+ "required": false,
+ "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": "the cache mode to use for this disk offering. none, writeback or writethrough",
+ "length": 255,
+ "name": "cachemode",
+ "required": false,
+ "since": "4.14",
+ "type": "string"
+ },
+ {
+ "description": "burst io requests write rate of the disk offering",
+ "length": 255,
+ "name": "iopswriteratemax",
+ "required": false,
+ "type": "long"
+ },
+ {
+ "description": "tags for the disk offering",
+ "length": 4096,
+ "name": "tags",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "details to specify disk offering parameters",
+ "length": 255,
+ "name": "details",
+ "required": false,
+ "since": "4.16",
+ "type": "map"
+ },
+ {
+ "description": "an optional field, whether to display the offering to the end user or not.",
+ "length": 255,
+ "name": "displayoffering",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "length (in seconds) of the burst",
+ "length": 255,
+ "name": "iopswriteratemaxlength",
+ "required": false,
+ "type": "long"
+ },
+ {
"description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.",
"length": 255,
"name": "provisioningtype",
@@ -71256,6 +72448,69 @@
"type": "string"
},
{
+ "description": "the storage type of the disk offering. Values are local and shared.",
+ "length": 255,
+ "name": "storagetype",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "bytes read rate of the disk offering",
+ "length": 255,
+ "name": "bytesreadrate",
+ "required": false,
+ "type": "long"
+ },
+ {
+ "description": "alternate display text of the disk offering",
+ "length": 4096,
+ "name": "displaytext",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "max iops of the disk offering",
+ "length": 255,
+ "name": "maxiops",
+ "required": false,
+ "type": "long"
+ },
+ {
+ "description": "io requests write rate of the disk offering",
+ "length": 255,
+ "name": "iopswriterate",
+ "required": false,
+ "type": "long"
+ },
+ {
+ "description": "io requests read rate of the disk offering",
+ "length": 255,
+ "name": "iopsreadrate",
+ "required": false,
+ "type": "long"
+ },
+ {
+ "description": "burst bytes write rate of the disk offering",
+ "length": 255,
+ "name": "byteswriteratemax",
+ "required": false,
+ "type": "long"
+ },
+ {
+ "description": "length (in seconds) of the burst",
+ "length": 255,
+ "name": "bytesreadratemaxlength",
+ "required": false,
+ "type": "long"
+ },
+ {
+ "description": "name of the disk offering",
+ "length": 255,
+ "name": "name",
+ "required": true,
+ "type": "string"
+ },
+ {
"description": "the ID of the containing zone(s), null for public offerings",
"length": 255,
"name": "zoneid",
@@ -71279,113 +72534,6 @@
"type": "long"
},
{
- "description": "alternate display text of the disk offering",
- "length": 4096,
- "name": "displaytext",
- "required": true,
- "type": "string"
- },
- {
- "description": "length (in seconds) of the burst",
- "length": 255,
- "name": "bytesreadratemaxlength",
- "required": false,
- "type": "long"
- },
- {
- "description": "tags for the disk offering",
- "length": 4096,
- "name": "tags",
- "required": false,
- "type": "string"
- },
- {
- "description": "an optional field, whether to display the offering to the end user or not.",
- "length": 255,
- "name": "displayoffering",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "min iops of the disk offering",
- "length": 255,
- "name": "miniops",
- "required": false,
- "type": "long"
- },
- {
- "description": "burst requests read rate of the disk offering",
- "length": 255,
- "name": "iopsreadratemax",
- "required": false,
- "type": "long"
- },
- {
- "description": "name of the disk offering",
- "length": 255,
- "name": "name",
- "required": true,
- "type": "string"
- },
- {
- "description": "burst bytes write rate of the disk offering",
- "length": 255,
- "name": "byteswriteratemax",
- "required": false,
- "type": "long"
- },
- {
- "description": "io requests write rate of the disk offering",
- "length": 255,
- "name": "iopswriterate",
- "required": false,
- "type": "long"
- },
- {
- "description": "length (in seconds) of the burst",
- "length": 255,
- "name": "iopswriteratemaxlength",
- "required": false,
- "type": "long"
- },
- {
- "description": "burst io requests write rate of the disk offering",
- "length": 255,
- "name": "iopswriteratemax",
- "required": false,
- "type": "long"
- },
- {
- "description": "whether disk offering iops is custom or not",
- "length": 255,
- "name": "customizediops",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "size of the disk offering in GB (1GB = 1,073,741,824 bytes)",
- "length": 255,
- "name": "disksize",
- "required": false,
- "type": "long"
- },
- {
- "description": "the ID of the containing domain(s), null for public offerings",
- "length": 255,
- "name": "domainid",
- "related": "listDomainChildren,listDomains",
- "required": false,
- "type": "list"
- },
- {
- "description": "the cache mode to use for this disk offering. none, writeback or writethrough",
- "length": 255,
- "name": "cachemode",
- "required": false,
- "since": "4.14",
- "type": "string"
- },
- {
"description": "bytes write rate of the disk offering",
"length": 255,
"name": "byteswriterate",
@@ -71393,35 +72541,6 @@
"type": "long"
},
{
- "description": "whether disk offering size is custom or not",
- "length": 255,
- "name": "customized",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "io requests read rate of the disk offering",
- "length": 255,
- "name": "iopsreadrate",
- "required": false,
- "type": "long"
- },
- {
- "description": "details to specify disk offering parameters",
- "length": 255,
- "name": "details",
- "required": false,
- "since": "4.16",
- "type": "map"
- },
- {
- "description": "max iops of the disk offering",
- "length": 255,
- "name": "maxiops",
- "required": false,
- "type": "long"
- },
- {
"description": "length (in seconds) of the burst",
"length": 255,
"name": "iopsreadratemaxlength",
@@ -71429,18 +72548,18 @@
"type": "long"
},
{
- "description": "bytes read rate of the disk offering",
+ "description": "min iops of the disk offering",
"length": 255,
- "name": "bytesreadrate",
+ "name": "miniops",
"required": false,
"type": "long"
},
{
- "description": "the storage type of the disk offering. Values are local and shared.",
+ "description": "size of the disk offering in GB (1GB = 1,073,741,824 bytes)",
"length": 255,
- "name": "storagetype",
+ "name": "disksize",
"required": false,
- "type": "string"
+ "type": "long"
},
{
"description": "burst bytes read rate of the disk offering",
@@ -71448,48 +72567,25 @@
"name": "bytesreadratemax",
"required": false,
"type": "long"
- },
- {
- "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"
}
],
"related": "",
"response": [
{
- "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the min iops of the disk offering",
- "name": "miniops",
+ "description": "bytes write rate of the disk offering",
+ "name": "diskBytesWriteRate",
"type": "long"
},
{
- "description": "the size of the disk offering in GB",
- "name": "disksize",
+ "description": "length (in seconds) of the burst",
+ "name": "diskIopsWriteRateMaxLength",
"type": "long"
},
+ {},
{
- "description": "the storage type for this disk offering",
- "name": "storagetype",
- "type": "string"
- },
- {
- "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": "the date this disk offering was created",
+ "name": "created",
+ "type": "date"
},
{
"description": "burst io requests write rate of the disk offering",
@@ -71497,18 +72593,18 @@
"type": "long"
},
{
- "description": "the date this disk offering was created",
- "name": "created",
- "type": "date"
+ "description": "burst bytes read rate of the disk offering",
+ "name": "diskBytesReadRateMax",
+ "type": "long"
},
{
- "description": "true if disk offering uses custom size, false otherwise",
- "name": "iscustomized",
- "type": "boolean"
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
},
{
- "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.",
- "name": "provisioningtype",
+ "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
+ "name": "domainid",
"type": "string"
},
{
@@ -71517,29 +72613,8 @@
"type": "boolean"
},
{
- "description": "io requests write rate of the disk offering",
- "name": "diskIopsWriteRate",
- "type": "long"
- },
- {
- "description": "io requests read rate of the disk offering",
- "name": "diskIopsReadRate",
- "type": "long"
- },
- {
- "description": "burst bytes read rate of the disk offering",
- "name": "diskBytesReadRateMax",
- "type": "long"
- },
- {},
- {
- "description": "bytes write rate of the disk offering",
- "name": "diskBytesWriteRate",
- "type": "long"
- },
- {
- "description": "burst io requests read rate of the disk offering",
- "name": "diskIopsReadRateMax",
+ "description": "length (in second) of the burst",
+ "name": "diskIopsReadRateMaxLength",
"type": "long"
},
{
@@ -71548,8 +72623,8 @@
"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 storage type for this disk offering",
+ "name": "storagetype",
"type": "string"
},
{
@@ -71558,8 +72633,38 @@
"type": "string"
},
{
- "description": "burst bytes write rate of the disk offering",
- "name": "diskBytesWriteRateMax",
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "length (in seconds) of the burst",
+ "name": "diskBytesReadRateMaxLength",
+ "type": "long"
+ },
+ {
+ "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": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "length (in seconds) of the burst",
+ "name": "diskBytesWriteRateMaxLength",
+ "type": "long"
+ },
+ {
+ "description": "io requests read rate of the disk offering",
+ "name": "diskIopsReadRate",
"type": "long"
},
{
@@ -71568,13 +72673,49 @@
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
+ "description": "burst bytes write rate of the disk offering",
+ "name": "diskBytesWriteRateMax",
+ "type": "long"
+ },
+ {
+ "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the tags for the disk offering",
+ "name": "tags",
+ "type": "string"
+ },
+ {
+ "description": "true if disk offering uses custom size, false otherwise",
+ "name": "iscustomized",
+ "type": "boolean"
+ },
+ {
+ "description": "the name of the disk offering",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the size of the disk offering in GB",
+ "name": "disksize",
+ "type": "long"
+ },
+ {
+ "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)",
+ "name": "hypervisorsnapshotreserve",
"type": "integer"
},
{
- "description": "the domain 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": "unique ID of the disk offering",
+ "name": "id",
"type": "string"
},
{
@@ -71583,60 +72724,29 @@
"type": "long"
},
{
- "description": "the name of the disk offering",
- "name": "name",
- "type": "string"
- },
- {
- "description": "length (in second) of the burst",
- "name": "diskIopsReadRateMaxLength",
- "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": "true if disk offering uses custom iops, false otherwise",
- "name": "iscustomizediops",
+ "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",
- "type": "integer"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.",
+ "name": "provisioningtype",
"type": "string"
},
{
- "description": "length (in seconds) of the burst",
- "name": "diskBytesReadRateMaxLength",
+ "description": "burst io requests read rate of the disk offering",
+ "name": "diskIopsReadRateMax",
"type": "long"
},
{
- "description": "length (in seconds) of the burst",
- "name": "diskIopsWriteRateMaxLength",
+ "description": "bytes read rate of the disk offering",
+ "name": "diskBytesReadRate",
"type": "long"
},
{
- "description": "length (in seconds) of the burst",
- "name": "diskBytesWriteRateMaxLength",
+ "description": "the min iops of the disk offering",
+ "name": "miniops",
"type": "long"
- },
- {
- "description": "the tags for the disk offering",
- "name": "tags",
- "type": "string"
- },
- {
- "description": "unique ID of the disk offering",
- "name": "id",
- "type": "string"
}
]
},
@@ -71646,19 +72756,62 @@
"name": "listVolumes",
"params": [
{
- "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,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume",
"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.",
+ "length": 255,
+ "name": "isrecursive",
+ "required": false,
"type": "boolean"
},
{
- "description": "List resources by tags (key/value pairs)",
+ "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.",
"length": 255,
- "name": "tags",
+ "name": "state",
"required": false,
- "type": "map"
+ "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",
+ "length": 255,
+ "name": "listall",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "list resources by account. Must be used with the domainId parameter.",
+ "length": 255,
+ "name": "account",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "list volumes on specified host",
+ "length": 255,
+ "name": "hostid",
+ "related": "addHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost",
+ "required": false,
+ "type": "uuid"
},
{
"description": "list objects by project",
@@ -71669,17 +72822,49 @@
"type": "uuid"
},
{
- "description": "the type of disk volume",
+ "description": "the ID of the storage pool, available to ROOT admin only",
"length": 255,
- "name": "type",
+ "name": "storageid",
+ "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool",
+ "required": false,
+ "since": "4.3",
+ "type": "string"
+ },
+ {
+ "description": "List resources by tags (key/value pairs)",
+ "length": 255,
+ "name": "tags",
+ "required": false,
+ "type": "map"
+ },
+ {
+ "description": "the name of the disk volume",
+ "length": 255,
+ "name": "name",
"required": false,
"type": "string"
},
{
- "description": "the ID of the availability zone",
+ "description": "the cluster id the disk volume belongs to",
"length": 255,
- "name": "zoneid",
- "related": "createZone,listZones,listZones",
+ "name": "clusterid",
+ "related": "addCluster",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter",
+ "length": 255,
+ "name": "displayvolume",
+ "required": false,
+ "since": "4.4",
+ "type": "boolean"
+ },
+ {
+ "description": "the ID of the virtual machine",
+ "length": 255,
+ "name": "virtualmachineid",
+ "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance",
"required": false,
"type": "uuid"
},
@@ -71693,35 +72878,6 @@
"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 ID of the virtual machine",
- "length": 255,
- "name": "virtualmachineid",
- "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance",
- "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": "the IDs of the volumes, mutually exclusive with id",
"length": 255,
"name": "ids",
@@ -71731,10 +72887,17 @@
"type": "list"
},
{
- "description": "list volumes on specified host",
+ "description": "the type of disk volume",
"length": 255,
- "name": "hostid",
- "related": "addHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost",
+ "name": "type",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the pod id the disk volume belongs to",
+ "length": 255,
+ "name": "podid",
+ "related": "updatePod,createManagementNetworkIpRange",
"required": false,
"type": "uuid"
},
@@ -71749,102 +72912,54 @@
{
"description": "",
"length": 255,
- "name": "page",
+ "name": "pagesize",
"required": false,
"type": "integer"
},
{
- "description": "the pod id the disk volume belongs to",
+ "description": "the ID of the availability zone",
"length": 255,
- "name": "podid",
- "related": "updatePod,createManagementNetworkIpRange",
+ "name": "zoneid",
+ "related": "createZone,listZones,listZones",
"required": false,
"type": "uuid"
- },
- {
- "description": "the name of the disk volume",
- "length": 255,
- "name": "name",
- "required": false,
- "type": "string"
- },
- {
- "description": "the ID of the disk volume",
- "length": 255,
- "name": "id",
- "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "the cluster id the disk volume belongs to",
- "length": 255,
- "name": "clusterid",
- "related": "addCluster",
- "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",
- "length": 255,
- "name": "listall",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
- "length": 255,
- "name": "isrecursive",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "list resources by account. Must be used with the domainId parameter.",
- "length": 255,
- "name": "account",
- "required": false,
- "type": "string"
- },
- {
- "description": "the ID of the storage pool, available to ROOT admin only",
- "length": 255,
- "name": "storageid",
- "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool",
- "required": false,
- "since": "4.3",
- "type": "string"
}
],
"related": "attachVolume,createVolume,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume",
"response": [
{
- "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 path of the volume",
- "name": "path",
+ "description": "ID of the service offering for root disk",
+ "name": "serviceofferingid",
"type": "string"
},
{
- "description": "the date the volume was attached to a VM instance",
- "name": "attached",
- "type": "date"
+ "description": "need quiesce vm or not when taking snapshot",
+ "name": "quiescevm",
+ "type": "boolean"
},
{
- "description": "the bytes allocated",
- "name": "physicalsize",
- "type": "long"
- },
- {
- "description": "the name of the ISO attached to the virtual machine",
- "name": "isoname",
+ "description": "name of the virtual machine",
+ "name": "vmname",
"type": "string"
},
{
- "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.",
- "name": "templateid",
+ "description": "cluster name where the volume is allocated",
+ "name": "clustername",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the vpn",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the disk utilization",
+ "name": "utilization",
"type": "string"
},
{
@@ -71853,189 +72968,83 @@
"type": "string"
},
{
- "description": "provisioning type used to create volumes.",
- "name": "provisioningtype",
- "type": "string"
- },
- {
- "description": "the project id of the vpn",
- "name": "projectid",
- "type": "string"
- },
- {
"description": "the ID of the ISO attached to the virtual machine",
"name": "isoid",
"type": "string"
},
{
- "description": "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": "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 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",
- "type": "string"
- },
- {
- "description": "the date the disk volume was created",
- "name": "created",
- "type": "date"
- },
- {},
- {
- "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": "true if storage snapshot is supported for the volume, false otherwise",
- "name": "supportsstoragesnapshot",
- "type": "boolean"
- },
- {
- "description": "ID of the availability zone",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "pod name of the volume",
- "name": "podname",
- "type": "string"
- },
- {
- "description": "the display text of the service offering for root disk",
- "name": "serviceofferingdisplaytext",
- "type": "string"
- },
- {
- "description": "the status of the volume",
- "name": "status",
- "type": "string"
- },
- {
- "description": "min iops of the disk volume",
- "name": "miniops",
- "type": "long"
- },
- {
- "description": "ID of the service offering for root disk",
- "name": "serviceofferingid",
- "type": "string"
- },
- {
- "description": "io requests read rate of the disk volume per the disk offering",
- "name": "diskIopsReadRate",
- "type": "long"
- },
- {
"description": "name of the primary storage hosting the disk volume",
"name": "storage",
"type": "string"
},
{
- "description": "name of the service offering for root disk",
- "name": "serviceofferingname",
- "type": "string"
- },
- {
- "description": "the state of the disk volume",
- "name": "state",
- "type": "string"
- },
- {
- "description": "shared or local storage",
- "name": "storagetype",
- "type": "string"
- },
- {
- "description": "bytes read rate of the disk volume",
- "name": "diskBytesReadRate",
+ "description": "io requests write rate of the disk volume per the disk offering",
+ "name": "diskIopsWriteRate",
"type": "long"
},
{
- "description": "display name of the virtual machine",
- "name": "vmdisplayname",
- "type": "string"
- },
- {
- "description": "the domain associated with the disk volume",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "Hypervisor the volume belongs to",
- "name": "hypervisor",
- "type": "string"
- },
- {
- "description": "id of the virtual machine",
- "name": "virtualmachineid",
- "type": "string"
- },
- {
- "description": "ID of the disk volume",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the disk volume",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the write (bytes) of disk on the vm",
- "name": "diskkbswrite",
- "type": "long"
- },
- {},
- {
- "description": "the project name of the vpn",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the chain info of the volume",
- "name": "chaininfo",
- "type": "string"
- },
- {
"description": "the read (io) of disk on the vm",
"name": "diskioread",
"type": "long"
},
{
+ "description": "the bytes actually consumed on disk",
+ "name": "virtualsize",
+ "type": "long"
+ },
+ {
+ "description": "type of the disk volume (ROOT or DATADISK)",
+ "name": "type",
+ "type": "string"
+ },
+ {
+ "description": "the write (bytes) of disk on the vm",
+ "name": "diskkbswrite",
+ "type": "long"
+ },
+ {
+ "description": "the bytes allocated",
+ "name": "physicalsize",
+ "type": "long"
+ },
+ {
+ "description": "true if the volume is extractable, false otherwise",
+ "name": "isextractable",
+ "type": "boolean"
+ },
+ {
+ "description": "an alternate display text of the ISO attached to the virtual machine",
+ "name": "isodisplaytext",
+ "type": "string"
+ },
+ {
+ "description": "ID of the snapshot from which this volume was created",
+ "name": "snapshotid",
+ "type": "string"
+ },
+ {},
+ {
"description": "the list of resource tags associated",
"name": "tags",
"response": [
{
- "description": "tag key name",
- "name": "key",
+ "description": "customer associated with the tag",
+ "name": "customer",
"type": "string"
},
{
- "description": "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"
},
{
@@ -72044,8 +73053,18 @@
"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": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
"type": "string"
},
{
@@ -72059,126 +73078,21 @@
"type": "string"
},
{
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
+ "description": "tag value",
+ "name": "value",
"type": "string"
},
{
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
+ "description": "id of the resource",
+ "name": "resourceid",
"type": "string"
}
],
"type": "set"
},
{
- "description": "name of the disk volume",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the boolean state of whether the volume is destroyed or not",
- "name": "destroyed",
- "type": "boolean"
- },
- {
- "description": "need quiesce vm or not when taking snapshot",
- "name": "quiescevm",
- "type": "boolean"
- },
- {
- "description": "ID of the snapshot from which this volume was created",
- "name": "snapshotid",
- "type": "string"
- },
- {
- "description": "the display text of the disk offering",
- "name": "diskofferingdisplaytext",
- "type": "string"
- },
- {
- "description": "an alternate display text of the ISO attached to the virtual machine",
- "name": "isodisplaytext",
- "type": "string"
- },
- {
- "description": "type of the disk volume (ROOT or DATADISK)",
- "name": "type",
- "type": "string"
- },
- {
- "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.",
- "name": "deviceid",
- "type": "long"
- },
- {
- "description": "max iops of the disk volume",
- "name": "maxiops",
- "type": "long"
- },
- {
- "description": "true if the volume is extractable, false otherwise",
- "name": "isextractable",
- "type": "boolean"
- },
- {
- "description": "ID of the disk offering",
- "name": "diskofferingid",
- "type": "string"
- },
- {
- "description": "pod id of the volume",
- "name": "podid",
- "type": "string"
- },
- {
- "description": "the bytes actually consumed on disk",
- "name": "virtualsize",
- "type": "long"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "name of the virtual machine",
- "name": "vmname",
- "type": "string"
- },
- {
- "description": "cluster name where the volume is allocated",
- "name": "clustername",
- "type": "string"
- },
- {
- "description": "size of the disk volume",
- "name": "size",
- "type": "long"
- },
- {
- "description": "name of the disk offering",
- "name": "diskofferingname",
- "type": "string"
- },
- {
- "description": "the write (io) of disk on the vm",
- "name": "diskiowrite",
- "type": "long"
- },
- {
- "description": "the read (bytes) of disk on the vm",
- "name": "diskkbsread",
- "type": "long"
- },
- {
- "description": "cluster id of the volume",
- "name": "clusterid",
+ "description": "ID of the disk volume",
+ "name": "id",
"type": "string"
},
{
@@ -72187,19 +73101,215 @@
"type": "string"
},
{
+ "description": "ID of the disk offering",
+ "name": "diskofferingid",
+ "type": "string"
+ },
+ {
+ "description": "the date the volume was attached to a VM instance",
+ "name": "attached",
+ "type": "date"
+ },
+ {
+ "description": "the name of the ISO attached to the virtual machine",
+ "name": "isoname",
+ "type": "string"
+ },
+ {
+ "description": "the date the disk volume was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "name of the disk volume",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "pod id of the volume",
+ "name": "podid",
+ "type": "string"
+ },
+ {
+ "description": "the status of the volume",
+ "name": "status",
+ "type": "string"
+ },
+ {
"description": "name of the availability zone",
"name": "zonename",
"type": "string"
},
{
- "description": "io requests write rate of the disk volume per the disk offering",
- "name": "diskIopsWriteRate",
+ "description": "the display text of the disk offering",
+ "name": "diskofferingdisplaytext",
+ "type": "string"
+ },
+ {
+ "description": "io requests read rate of the disk volume per the disk offering",
+ "name": "diskIopsReadRate",
+ "type": "long"
+ },
+ {
+ "description": "the domain associated with the disk volume",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "max iops of the disk volume",
+ "name": "maxiops",
"type": "long"
},
{
"description": " an alternate display text of the template for the virtual machine",
"name": "templatedisplaytext",
"type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the disk volume",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "id of the virtual machine",
+ "name": "virtualmachineid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the template for the virtual machine",
+ "name": "templatename",
+ "type": "string"
+ },
+ {
+ "description": "display name of the virtual machine",
+ "name": "vmdisplayname",
+ "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": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "name of the disk offering",
+ "name": "diskofferingname",
+ "type": "string"
+ },
+ {
+ "description": "size of the disk volume",
+ "name": "size",
+ "type": "long"
+ },
+ {
+ "description": "the write (io) of disk on the vm",
+ "name": "diskiowrite",
+ "type": "long"
+ },
+ {
+ "description": "bytes write rate of the disk volume",
+ "name": "diskBytesWriteRate",
+ "type": "long"
+ },
+ {
+ "description": "pod name of the volume",
+ "name": "podname",
+ "type": "string"
+ },
+ {
+ "description": "cluster id of the volume",
+ "name": "clusterid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.",
+ "name": "templateid",
+ "type": "string"
+ },
+ {
+ "description": "name of the service offering for root disk",
+ "name": "serviceofferingname",
+ "type": "string"
+ },
+ {
+ "description": "the state of the disk volume",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "the read (bytes) of disk on the vm",
+ "name": "diskkbsread",
+ "type": "long"
+ },
+ {
+ "description": "the project id of the vpn",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the display text of the service offering for root disk",
+ "name": "serviceofferingdisplaytext",
+ "type": "string"
+ },
+ {
+ "description": "an optional field whether to the display the volume to the end user or not.",
+ "name": "displayvolume",
+ "type": "boolean"
+ },
+ {
+ "description": "the path of the volume",
+ "name": "path",
+ "type": "string"
+ },
+ {
+ "description": "shared or local storage",
+ "name": "storagetype",
+ "type": "string"
+ },
+ {
+ "description": "ID of the availability zone",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "bytes read rate of the disk volume",
+ "name": "diskBytesReadRate",
+ "type": "long"
+ },
+ {
+ "description": "provisioning type used to create volumes.",
+ "name": "provisioningtype",
+ "type": "string"
+ },
+ {
+ "description": "the chain info of the volume",
+ "name": "chaininfo",
+ "type": "string"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the account associated with the disk volume",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "min iops of the disk volume",
+ "name": "miniops",
+ "type": "long"
}
]
},
@@ -72209,13 +73319,6 @@
"name": "createLBHealthCheckPolicy",
"params": [
{
- "description": "the description of the load balancer health check policy",
- "length": 255,
- "name": "description",
- "required": false,
- "type": "string"
- },
- {
"description": "HTTP ping path",
"length": 255,
"name": "pingpath",
@@ -72230,13 +73333,6 @@
"type": "integer"
},
{
- "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,
"name": "fordisplay",
@@ -72245,6 +73341,14 @@
"type": "boolean"
},
{
+ "description": "the ID of the load balancer rule",
+ "length": 255,
+ "name": "lbruleid",
+ "related": "",
+ "required": true,
+ "type": "uuid"
+ },
+ {
"description": "Amount of time between health checks (1 sec - 20940 sec)",
"length": 255,
"name": "intervaltime",
@@ -72252,6 +73356,13 @@
"type": "integer"
},
{
+ "description": "Number of consecutive health check success before declaring an instance healthy",
+ "length": 255,
+ "name": "healthythreshold",
+ "required": false,
+ "type": "integer"
+ },
+ {
"description": "Number of consecutive health check failures before declaring an instance unhealthy",
"length": 255,
"name": "unhealthythreshold",
@@ -72259,44 +73370,32 @@
"type": "integer"
},
{
- "description": "the ID of the load balancer rule",
+ "description": "the description of the load balancer health check policy",
"length": 255,
- "name": "lbruleid",
- "related": "",
- "required": true,
- "type": "uuid"
+ "name": "description",
+ "required": false,
+ "type": "string"
}
],
"related": "listLBHealthCheckPolicies",
"response": [
{
+ "description": "the domain ID of the HealthCheck policy",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
"description": "the id of the zone the HealthCheck policy belongs to",
"name": "zoneid",
"type": "string"
},
{
- "description": "the LB rule ID",
- "name": "lbruleid",
- "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 list of healthcheckpolicies",
"name": "healthcheckpolicy",
"response": [
{
- "description": "the pingpath of the healthcheck policy",
- "name": "pingpath",
+ "description": "the LB HealthCheck policy ID",
+ "name": "id",
"type": "string"
},
{
@@ -72310,26 +73409,11 @@
"type": "string"
},
{
- "description": "the LB HealthCheck policy ID",
- "name": "id",
- "type": "string"
- },
- {
- "description": "Amount of time between health checks",
- "name": "healthcheckinterval",
- "type": "int"
- },
- {
"description": "Time to wait when receiving a response from the health check",
"name": "responsetime",
"type": "int"
},
{
- "description": "Number of consecutive health check success before declaring an instance healthy",
- "name": "healthcheckthresshold",
- "type": "int"
- },
- {
"description": "is policy for display to the regular user",
"name": "fordisplay",
"type": "boolean"
@@ -72338,14 +73422,34 @@
"description": "Number of consecutive health check failures before declaring an instance unhealthy.",
"name": "unhealthcheckthresshold",
"type": "int"
+ },
+ {
+ "description": "Amount of time between health checks",
+ "name": "healthcheckinterval",
+ "type": "int"
+ },
+ {
+ "description": "Number of consecutive health check success before declaring an instance healthy",
+ "name": "healthcheckthresshold",
+ "type": "int"
+ },
+ {
+ "description": "the pingpath of the healthcheck policy",
+ "name": "pingpath",
+ "type": "string"
}
],
"type": "list"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "the LB rule ID",
+ "name": "lbruleid",
+ "type": "string"
+ },
+ {
+ "description": "the account of the HealthCheck policy",
+ "name": "account",
+ "type": "string"
},
{},
{
@@ -72354,10 +73458,16 @@
"type": "string"
},
{
+ "description": "the current status of the latest async job 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"
},
@@ -72377,36 +73487,16 @@
],
"related": "createUser,disableUser,enableUser,getUser,listUsers,updateUser",
"response": [
- {
- "description": "the name of the role",
- "name": "rolename",
- "type": "string"
- },
{},
{
- "description": "the type of the role",
- "name": "roletype",
+ "description": "the domain name of the user",
+ "name": "domain",
"type": "string"
},
{
- "description": "the account ID of the user",
- "name": "accountid",
- "type": "string"
- },
- {
- "description": "the user firstname",
- "name": "firstname",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the ID of the role",
- "name": "roleid",
- "type": "string"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
{
"description": "the user ID",
@@ -72414,30 +73504,19 @@
"type": "string"
},
{
+ "description": "the user name",
+ "name": "username",
+ "type": "string"
+ },
+ {
"description": "the api key of the user",
"name": "apikey",
"type": "string"
},
{
- "description": "the domain name of the user",
- "name": "domain",
- "type": "string"
- },
- {},
- {
- "description": "true if user is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
- },
- {
- "description": "the 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 date and time the user account was created",
+ "name": "created",
+ "type": "date"
},
{
"description": "the boolean value representing if the updating target is in caller's child domain",
@@ -72445,8 +73524,43 @@
"type": "boolean"
},
{
- "description": "the user lastname",
- "name": "lastname",
+ "description": "the account type of the user",
+ "name": "accounttype",
+ "type": "short"
+ },
+ {
+ "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 timezone user was created in",
+ "name": "timezone",
+ "type": "string"
+ },
+ {
+ "description": "the user firstname",
+ "name": "firstname",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the role",
+ "name": "roleid",
+ "type": "string"
+ },
+ {
+ "description": "the secret key of the user",
+ "name": "secretkey",
+ "type": "string"
+ },
+ {
+ "description": "the account name of the user",
+ "name": "account",
"type": "string"
},
{
@@ -72460,33 +73574,24 @@
"type": "string"
},
{
- "description": "the account type of the user",
- "name": "accounttype",
- "type": "short"
- },
- {
- "description": "the secret key of the user",
- "name": "secretkey",
+ "description": "the user email address",
+ "name": "email",
"type": "string"
},
{
- "description": "the user name",
- "name": "username",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the account ID of the user",
+ "name": "accountid",
"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 timezone user was created in",
- "name": "timezone",
+ "description": "the user lastname",
+ "name": "lastname",
"type": "string"
},
{
@@ -72495,8 +73600,13 @@
"type": "string"
},
{
- "description": "the user email address",
- "name": "email",
+ "description": "the type of the role",
+ "name": "roletype",
+ "type": "string"
+ },
+ {
+ "description": "the name of the role",
+ "name": "rolename",
"type": "string"
}
]
@@ -72514,11 +73624,10 @@
"type": "boolean"
},
{
- "description": "the Cloudian Management Console base URL",
- "name": "url",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
- {},
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
@@ -72526,10 +73635,11 @@
},
{},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the Cloudian Management Console base URL",
+ "name": "url",
"type": "string"
- }
+ },
+ {}
],
"since": "4.11.0"
},
@@ -72541,11 +73651,28 @@
{
"description": "",
"length": 255,
- "name": "pagesize",
+ "name": "page",
"required": false,
"type": "integer"
},
{
+ "description": "the ID of the health check policy",
+ "length": 255,
+ "name": "id",
+ "related": "listLBHealthCheckPolicies",
+ "required": false,
+ "since": "4.4",
+ "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": "List by keyword",
"length": 255,
"name": "keyword",
@@ -72561,50 +73688,34 @@
"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": "the ID of the health check policy",
- "length": 255,
- "name": "id",
- "related": "listLBHealthCheckPolicies",
- "required": false,
- "since": "4.4",
- "type": "uuid"
- },
- {
"description": "",
"length": 255,
- "name": "page",
+ "name": "pagesize",
"required": false,
"type": "integer"
}
],
"related": "",
"response": [
+ {},
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
{
"description": "the list of healthcheckpolicies",
"name": "healthcheckpolicy",
"response": [
{
- "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": "is policy for display to the regular user",
- "name": "fordisplay",
- "type": "boolean"
- },
- {
- "description": "Amount of time between health checks",
- "name": "healthcheckinterval",
- "type": "int"
+ "description": "the state of the policy",
+ "name": "state",
+ "type": "string"
},
{
"description": "Time to wait when receiving a response from the health check",
@@ -72622,60 +73733,59 @@
"type": "string"
},
{
- "description": "the LB HealthCheck policy ID",
- "name": "id",
- "type": "string"
+ "description": "Number of consecutive health check success before declaring an instance healthy",
+ "name": "healthcheckthresshold",
+ "type": "int"
},
{
- "description": "the state of the policy",
- "name": "state",
- "type": "string"
+ "description": "Amount of time between health checks",
+ "name": "healthcheckinterval",
+ "type": "int"
},
{
"description": "the description of the healthcheck policy",
"name": "description",
"type": "string"
+ },
+ {
+ "description": "is policy for display to the regular user",
+ "name": "fordisplay",
+ "type": "boolean"
}
],
"type": "list"
},
{
- "description": "the LB rule ID",
- "name": "lbruleid",
- "type": "string"
- },
- {
- "description": "the id of the zone the HealthCheck policy belongs to",
- "name": "zoneid",
- "type": "string"
- },
- {},
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {},
- {
"description": "the domain ID of the HealthCheck policy",
"name": "domainid",
"type": "string"
},
{
- "description": "the domain of the HealthCheck policy",
- "name": "domain",
- "type": "string"
- },
- {
"description": "the account of the HealthCheck policy",
"name": "account",
"type": "string"
},
{
+ "description": "the domain of the HealthCheck policy",
+ "name": "domain",
+ "type": "string"
+ },
+ {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
- }
+ },
+ {
+ "description": "the id of the zone the HealthCheck policy belongs to",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the LB rule ID",
+ "name": "lbruleid",
+ "type": "string"
+ },
+ {}
],
"since": "4.2.0"
},
@@ -72685,45 +73795,31 @@
"name": "createNetwork",
"params": [
{
- "description": "an optional project for the SSH key",
+ "description": "an optional field, whether to the display the network to the end user or not.",
"length": 255,
- "name": "projectid",
- "related": "activateProject,suspendProject,updateProject",
+ "name": "displaynetwork",
"required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "the network offering ID",
+ "length": 255,
+ "name": "networkofferingid",
+ "related": "listNetworkOfferings",
+ "required": true,
"type": "uuid"
},
{
- "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": "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": "the ID or VID of the network",
"length": 255,
- "name": "acltype",
- "required": false,
- "type": "string"
- },
- {
- "description": "the isolated private VLAN type for this network",
- "length": 255,
- "name": "isolatedpvlantype",
- "required": false,
- "type": "string"
- },
- {
- "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 gateway of the network. Required for shared networks and isolated networks when it belongs to VPC",
- "length": 255,
- "name": "gateway",
+ "name": "vlan",
"required": false,
"type": "string"
},
@@ -72736,47 +73832,67 @@
"type": "uuid"
},
{
- "description": "Network ACL ID associated for the network",
+ "description": "the gateway of the network. Required for shared networks and isolated networks when it belongs to VPC",
"length": 255,
- "name": "aclid",
- "related": "createNetworkACLList",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "the beginning IPv6 address in the IPv6 network range",
- "length": 255,
- "name": "startipv6",
+ "name": "gateway",
"required": false,
"type": "string"
},
{
- "description": "IPV4 address to be assigned to a router in a shared network",
+ "description": "network domain",
"length": 255,
- "name": "routerip",
+ "name": "networkdomain",
"required": false,
- "since": "4.16",
"type": "string"
},
{
- "description": "the network offering ID",
+ "description": "the isolated private VLAN type for this network",
"length": 255,
- "name": "networkofferingid",
- "related": "listNetworkOfferings",
+ "name": "isolatedpvlantype",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the zone ID for the network",
+ "length": 255,
+ "name": "zoneid",
+ "related": "createZone,listZones,listZones",
"required": true,
"type": "uuid"
},
{
- "description": "the ID or VID of the network",
+ "description": "domain ID of the account owning a network",
"length": 255,
- "name": "vlan",
+ "name": "domainid",
+ "related": "listDomainChildren,listDomains",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "Access control type; supported values are account and domain. In 3.0 all shared networks should have aclType=Domain, and all isolated networks - Account. Account means that only the account owner can use the network, domain - all accounts in the domain can use the network",
+ "length": 255,
+ "name": "acltype",
"required": false,
"type": "string"
},
{
- "description": "the beginning IP address in the network IP range",
+ "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": "startip",
+ "name": "subdomainaccess",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "the isolated private VLAN for this network",
+ "length": 255,
+ "name": "isolatedpvlan",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the ending IPv6 address in the IPv6 network range",
+ "length": 255,
+ "name": "endipv6",
"required": false,
"type": "string"
},
@@ -72788,32 +73904,19 @@
"type": "string"
},
{
- "description": "an optional field, whether to the display the network to the end user or not.",
+ "description": "the beginning IP address in the network IP range",
"length": 255,
- "name": "displaynetwork",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "the display text of the network",
- "length": 255,
- "name": "displaytext",
- "required": true,
- "type": "string"
- },
- {
- "description": "the isolated private VLAN for this network",
- "length": 255,
- "name": "isolatedpvlan",
+ "name": "startip",
"required": false,
"type": "string"
},
{
- "description": "the CIDR of IPv6 network, must be at least /64",
+ "description": "an optional project for the SSH key",
"length": 255,
- "name": "ip6cidr",
+ "name": "projectid",
+ "related": "activateProject,suspendProject,updateProject",
"required": false,
- "type": "string"
+ "type": "uuid"
},
{
"description": "the ending IP address in the network IP range. If not specified, will be defaulted to startIP",
@@ -72823,6 +73926,43 @@
"type": "string"
},
{
+ "description": "the name of the network",
+ "length": 255,
+ "name": "name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "Network ACL ID associated for the network",
+ "length": 255,
+ "name": "aclid",
+ "related": "createNetworkACLList",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "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": "when true bypasses VLAN id/range overlap check during network creation for shared and L2 networks",
+ "length": 255,
+ "name": "bypassvlanoverlapcheck",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "the 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": "ID of the network in an external system.",
"length": 255,
"name": "externalid",
@@ -72830,6 +73970,13 @@
"type": "string"
},
{
+ "description": "the CIDR of IPv6 network, must be at least /64",
+ "length": 255,
+ "name": "ip6cidr",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "the physical network ID the network belongs to",
"length": 255,
"name": "physicalnetworkid",
@@ -72838,34 +73985,11 @@
"type": "uuid"
},
{
- "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",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "the zone ID for the network",
- "length": 255,
- "name": "zoneid",
- "related": "createZone,listZones,listZones",
+ "name": "displaytext",
"required": true,
- "type": "uuid"
- },
- {
- "description": "when true bypasses VLAN id/range overlap check during network creation for shared and L2 networks",
- "length": 255,
- "name": "bypassvlanoverlapcheck",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "domain ID of the account owning a network",
- "length": 255,
- "name": "domainid",
- "related": "listDomainChildren,listDomains",
- "required": false,
- "type": "uuid"
+ "type": "string"
},
{
"description": "when true ip address usage for the network will not be exported by the listUsageRecords API",
@@ -72875,13 +73999,6 @@
"type": "boolean"
},
{
- "description": "network domain",
- "length": 255,
- "name": "networkdomain",
- "required": false,
- "type": "string"
- },
- {
"description": "account that will own the network",
"length": 255,
"name": "account",
@@ -72889,13 +74006,6 @@
"type": "string"
},
{
- "description": "the name of the network",
- "length": 255,
- "name": "name",
- "required": true,
- "type": "string"
- },
- {
"description": "IPV6 address to be assigned to a router in a shared network",
"length": 255,
"name": "routeripv6",
@@ -72906,310 +74016,129 @@
],
"related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks",
"response": [
- {},
- {
- "description": "the name of the zone the network belongs to",
- "name": "zonename",
- "type": "string"
- },
- {},
- {
- "description": "zone id of the network",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the first DNS for the network",
- "name": "dns1",
- "type": "string"
- },
- {
- "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans",
- "name": "zonesnetworkspans",
- "type": "set"
- },
- {
- "description": "true if network offering is ip conserve mode enabled",
- "name": "networkofferingconservemode",
- "type": "boolean"
- },
- {
- "description": "the list of resource tags associated with network",
- "name": "tags",
- "response": [
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "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": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- }
- ],
- "type": "list"
- },
- {
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes",
- "name": "reservediprange",
- "type": "string"
- },
- {
- "description": "true if network is system, false otherwise",
- "name": "issystem",
- "type": "boolean"
- },
{
"description": "the id of the network",
"name": "id",
"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": "broadcast uri of the network. This parameter is visible to ROOT admins only",
- "name": "broadcasturi",
- "type": "string"
- },
- {
- "description": "the network's gateway",
- "name": "gateway",
- "type": "string"
- },
- {
- "description": "the owner of the network",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the traffic type of the network",
- "name": "traffictype",
- "type": "string"
- },
- {
- "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",
- "type": "string"
- },
- {
- "description": "list networks that are persistent",
- "name": "ispersistent",
- "type": "boolean"
- },
- {
- "description": "related to what other network configuration",
- "name": "related",
- "type": "string"
- },
- {
- "description": "an optional field, whether to the display the network to the end user or not.",
- "name": "displaynetwork",
- "type": "boolean"
- },
- {
- "description": "list networks available for vm deployment",
- "name": "canusefordeploy",
- "type": "boolean"
- },
- {
- "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 details of the network",
- "name": "details",
- "type": "map"
- },
- {
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
- },
- {
- "description": "Broadcast domain type of the network",
- "name": "broadcastdomaintype",
- "type": "string"
- },
- {
- "description": "ACL name associated with the VPC network",
- "name": "aclname",
- "type": "string"
- },
- {
- "description": "Name of the VPC to which this network belongs",
- "name": "vpcname",
- "type": "string"
- },
- {
- "description": "the type of the network",
- "name": "type",
- "type": "string"
- },
- {
- "description": "The external id of the network",
- "name": "externalid",
- "type": "string"
- },
- {
- "description": "the date this network was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "true if network supports specifying ip ranges, false otherwise",
- "name": "specifyipranges",
- "type": "boolean"
- },
- {
- "description": "the total number of network traffic bytes sent",
- "name": "sentbytes",
- "type": "long"
- },
- {
- "description": "the network domain",
- "name": "networkdomain",
- "type": "string"
- },
- {
- "description": "network offering id the network is created from",
- "name": "networkofferingid",
- "type": "string"
- },
- {
- "description": "true if network can span multiple zones",
- "name": "strechedl2subnet",
- "type": "boolean"
- },
- {
- "description": "the second DNS for the network",
- "name": "dns2",
- "type": "string"
- },
- {
- "description": "ACL Id associated with the VPC network",
- "name": "aclid",
- "type": "string"
- },
- {
- "description": "the physical network id",
- "name": "physicalnetworkid",
- "type": "string"
- },
- {
- "description": "VPC the network belongs to",
- "name": "vpcid",
- "type": "string"
- },
- {
- "description": "The vlan of the network. This parameter is visible to ROOT admins only",
- "name": "vlan",
- "type": "string"
- },
- {
- "description": "the gateway of IPv6 network",
- "name": "ip6gateway",
- "type": "string"
- },
- {
- "description": "the name of the network",
- "name": "name",
- "type": "string"
- },
- {
- "description": "true network requires restart",
- "name": "restartrequired",
- "type": "boolean"
- },
- {
- "description": "the network's netmask",
- "name": "netmask",
- "type": "string"
- },
- {
- "description": "true if users from subdomains can access the domain level network",
- "name": "subdomainaccess",
- "type": "boolean"
- },
- {
- "description": "the project name of the address",
- "name": "project",
- "type": "string"
- },
- {
- "description": "state of the network",
- "name": "state",
- "type": "string"
- },
- {
"description": "the total number of network traffic bytes received",
"name": "receivedbytes",
"type": "long"
},
{
+ "description": "the total number of network traffic bytes sent",
+ "name": "sentbytes",
+ "type": "long"
+ },
+ {
+ "description": "the name of the network",
+ "name": "name",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "The external id of the network",
+ "name": "externalid",
+ "type": "string"
+ },
+ {
+ "description": "broadcast uri of the network. This parameter is visible to ROOT admins only",
+ "name": "broadcasturi",
+ "type": "string"
+ },
+ {
+ "description": "VPC the network belongs to",
+ "name": "vpcid",
+ "type": "string"
+ },
+ {
+ "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE",
+ "name": "networkcidr",
+ "type": "string"
+ },
+ {
+ "description": "true if network is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {
+ "description": "true if users from subdomains can access the domain level network",
+ "name": "subdomainaccess",
+ "type": "boolean"
+ },
+ {
+ "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 type of the network",
+ "name": "type",
+ "type": "string"
+ },
+ {
+ "description": "the domain name of the network owner",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "acl type - access type to the network",
+ "name": "acltype",
+ "type": "string"
+ },
+ {
"description": "the list of services",
"name": "service",
"response": [
{
+ "description": "the service provider name",
+ "name": "provider",
+ "response": [
+ {
+ "description": "the physical network this belongs to",
+ "name": "physicalnetworkid",
+ "type": "string"
+ },
+ {
+ "description": "the destination physical network",
+ "name": "destinationphysicalnetworkid",
+ "type": "string"
+ },
+ {
+ "description": "services for this provider",
+ "name": "servicelist",
+ "type": "list"
+ },
+ {
+ "description": "the provider name",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "state of the network provider",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "uuid of the network provider",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "true if individual services can be enabled/disabled",
+ "name": "canenableindividualservice",
+ "type": "boolean"
+ }
+ ],
+ "type": "list"
+ },
+ {
"description": "the list of capabilities",
"name": "capability",
"response": [
@@ -73235,61 +74164,19 @@
"description": "the service name",
"name": "name",
"type": "string"
- },
- {
- "description": "the service provider name",
- "name": "provider",
- "response": [
- {
- "description": "true if individual services can be enabled/disabled",
- "name": "canenableindividualservice",
- "type": "boolean"
- },
- {
- "description": "the destination physical network",
- "name": "destinationphysicalnetworkid",
- "type": "string"
- },
- {
- "description": "the provider name",
- "name": "name",
- "type": "string"
- },
- {
- "description": "uuid of the network provider",
- "name": "id",
- "type": "string"
- },
- {
- "description": "services for this provider",
- "name": "servicelist",
- "type": "list"
- },
- {
- "description": "the physical network this belongs to",
- "name": "physicalnetworkid",
- "type": "string"
- },
- {
- "description": "state of the network provider",
- "name": "state",
- "type": "string"
- }
- ],
- "type": "list"
}
],
"type": "list"
},
{
- "description": "true if network is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
+ "description": "the network's gateway",
+ "name": "gateway",
+ "type": "string"
},
{
- "description": "the project id of the ipaddress",
- "name": "projectid",
- "type": "string"
+ "description": "true network requires restart",
+ "name": "restartrequired",
+ "type": "boolean"
},
{
"description": "display text of the network offering the network is created from",
@@ -73297,28 +74184,68 @@
"type": "string"
},
{
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR",
+ "name": "cidr",
+ "type": "string"
+ },
+ {
+ "description": "Name of the VPC to which this network belongs",
+ "name": "vpcname",
+ "type": "string"
+ },
+ {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
{
- "description": "the domain name of the network owner",
- "name": "domain",
+ "description": "Broadcast domain type of the network",
+ "name": "broadcastdomaintype",
"type": "string"
},
{
- "description": "If the network has redundant routers enabled",
- "name": "redundantrouter",
+ "description": "the network's netmask",
+ "name": "netmask",
+ "type": "string"
+ },
+ {
+ "description": "true if network offering is ip conserve mode enabled",
+ "name": "networkofferingconservemode",
"type": "boolean"
},
{
- "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR",
- "name": "cidr",
+ "description": "the domain id of the network owner",
+ "name": "domainid",
"type": "string"
},
{
- "description": "the cidr of IPv6 network",
- "name": "ip6cidr",
+ "description": "related to what other network configuration",
+ "name": "related",
+ "type": "string"
+ },
+ {
+ "description": "zone id of the network",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "an optional field, whether to the display the network to the end user or not.",
+ "name": "displaynetwork",
+ "type": "boolean"
+ },
+ {
+ "description": "state of the network",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "network offering id the network is created from",
+ "name": "networkofferingid",
"type": "string"
},
{
@@ -73327,8 +74254,191 @@
"type": "string"
},
{
- "description": "the domain id of the network owner",
- "name": "domainid",
+ "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes",
+ "name": "reservediprange",
+ "type": "string"
+ },
+ {
+ "description": "list networks available for vm deployment",
+ "name": "canusefordeploy",
+ "type": "boolean"
+ },
+ {
+ "description": "true if network supports specifying ip ranges, false otherwise",
+ "name": "specifyipranges",
+ "type": "boolean"
+ },
+ {
+ "description": "The vlan of the network. This parameter is visible to ROOT admins only",
+ "name": "vlan",
+ "type": "string"
+ },
+ {
+ "description": "the date this network was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the list of resource tags associated with network",
+ "name": "tags",
+ "response": [
+ {
+ "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": "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": "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": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ }
+ ],
+ "type": "list"
+ },
+ {
+ "description": "the network domain",
+ "name": "networkdomain",
+ "type": "string"
+ },
+ {
+ "description": "true if network can span multiple zones",
+ "name": "strechedl2subnet",
+ "type": "boolean"
+ },
+ {},
+ {
+ "description": "the project name of the address",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans",
+ "name": "zonesnetworkspans",
+ "type": "set"
+ },
+ {
+ "description": "the second DNS for the network",
+ "name": "dns2",
+ "type": "string"
+ },
+ {
+ "description": "If the network has redundant routers enabled",
+ "name": "redundantrouter",
+ "type": "boolean"
+ },
+ {
+ "description": "the owner of the network",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the first DNS for the network",
+ "name": "dns1",
+ "type": "string"
+ },
+ {
+ "description": "the gateway of IPv6 network",
+ "name": "ip6gateway",
+ "type": "string"
+ },
+ {
+ "description": "ACL Id associated with the VPC network",
+ "name": "aclid",
+ "type": "string"
+ },
+ {
+ "description": "availability of the network offering the network is created from",
+ "name": "networkofferingavailability",
+ "type": "string"
+ },
+ {
+ "description": "list networks that are persistent",
+ "name": "ispersistent",
+ "type": "boolean"
+ },
+ {
+ "description": "ACL name associated with the VPC network",
+ "name": "aclname",
+ "type": "string"
+ },
+ {
+ "description": "the physical network id",
+ "name": "physicalnetworkid",
+ "type": "string"
+ },
+ {
+ "description": "the project id of the ipaddress",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the details of the network",
+ "name": "details",
+ "type": "map"
+ },
+ {
+ "description": "the traffic type of the network",
+ "name": "traffictype",
+ "type": "string"
+ },
+ {
+ "description": "the cidr of IPv6 network",
+ "name": "ip6cidr",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the name of the zone the network belongs to",
+ "name": "zonename",
"type": "string"
}
]
@@ -73339,108 +74449,13 @@
"name": "listNetworkOfferings",
"params": [
{
- "description": "true if need to list only default network offerings. Default value is false",
+ "description": "true if need to list only network offerings which support specifying ip ranges",
"length": 255,
- "name": "isdefault",
+ "name": "specifyipranges",
"required": false,
"type": "boolean"
},
{
- "description": "list network offerings by guest type: shared or isolated",
- "length": 255,
- "name": "guestiptype",
- "required": false,
- "type": "string"
- },
- {
- "description": "list network offerings by ID",
- "length": 255,
- "name": "id",
- "related": "listNetworkOfferings",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "list network offerings available for network creation in specific domain",
- "length": 255,
- "name": "domainid",
- "related": "listDomainChildren,listDomains",
- "required": false,
- "since": "4.13",
- "type": "uuid"
- },
- {
- "description": "list network offerings supporting certain services",
- "length": 255,
- "name": "supportedservices",
- "required": false,
- "type": "list"
- },
- {
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
- },
- {
- "description": "list network offerings available for network creation in specific zone",
- "length": 255,
- "name": "zoneid",
- "related": "createZone,listZones,listZones",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "the network offering can be used only for network creation inside the VPC",
- "length": 255,
- "name": "forvpc",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "the tags for the network offering.",
- "length": 255,
- "name": "specifyvlan",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "list network offerings by name",
- "length": 255,
- "name": "name",
- "required": false,
- "type": "string"
- },
- {
- "description": "true if offering has tags specified",
- "length": 255,
- "name": "istagged",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "list network offerings by tags",
- "length": 4096,
- "name": "tags",
- "required": false,
- "type": "string"
- },
- {
- "description": "list by traffic type",
- "length": 255,
- "name": "traffictype",
- "required": false,
- "type": "string"
- },
- {
- "description": "the availability of network offering. Default value is required",
- "length": 255,
- "name": "availability",
- "required": false,
- "type": "string"
- },
- {
"description": "list network offerings by display text",
"length": 255,
"name": "displaytext",
@@ -73448,13 +74463,6 @@
"type": "string"
},
{
- "description": "",
- "length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
- },
- {
"description": "the ID of the network. Pass this in if you want to see the available network offering that a network can be changed to.",
"length": 255,
"name": "networkid",
@@ -73470,13 +74478,50 @@
"type": "boolean"
},
{
- "description": "true if need to list only network offerings which support specifying ip ranges",
+ "description": "list network offerings by tags",
+ "length": 4096,
+ "name": "tags",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the tags for the network offering.",
"length": 255,
- "name": "specifyipranges",
+ "name": "specifyvlan",
"required": false,
"type": "boolean"
},
{
+ "description": "list network offerings supporting certain services",
+ "length": 255,
+ "name": "supportedservices",
+ "required": false,
+ "type": "list"
+ },
+ {
+ "description": "list network offerings by ID",
+ "length": 255,
+ "name": "id",
+ "related": "listNetworkOfferings",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "list network offerings available for network creation in specific zone",
+ "length": 255,
+ "name": "zoneid",
+ "related": "createZone,listZones,listZones",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "list network offerings by name",
+ "length": 255,
+ "name": "name",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "",
"length": 255,
"name": "page",
@@ -73484,48 +74529,95 @@
"type": "integer"
},
{
+ "description": "true if offering has tags specified",
+ "length": 255,
+ "name": "istagged",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "list network offerings by guest type: shared or isolated",
+ "length": 255,
+ "name": "guestiptype",
+ "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": "true if need to list only default network offerings. Default value is false",
+ "length": 255,
+ "name": "isdefault",
+ "required": false,
+ "type": "boolean"
+ },
+ {
"description": "list network offerings by state",
"length": 255,
"name": "state",
"required": false,
"type": "string"
+ },
+ {
+ "description": "list network offerings available for network creation in specific domain",
+ "length": 255,
+ "name": "domainid",
+ "related": "listDomainChildren,listDomains",
+ "required": false,
+ "since": "4.13",
+ "type": "uuid"
+ },
+ {
+ "description": "list by traffic type",
+ "length": 255,
+ "name": "traffictype",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the availability of network offering. Default value is required",
+ "length": 255,
+ "name": "availability",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
}
],
"related": "",
"response": [
- {},
+ {
+ "description": "the ID of the service offering used by virtual router provider",
+ "name": "serviceofferingid",
+ "type": "string"
+ },
+ {
+ "description": "data transfer rate in megabits per second allowed.",
+ "name": "networkrate",
+ "type": "integer"
+ },
{
"description": "the list of supported services",
"name": "service",
"response": [
{
- "description": "the 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"
- },
- {
"description": "the service provider name",
"name": "provider",
"response": [
@@ -73535,26 +74627,26 @@
"type": "string"
},
{
- "description": "uuid of the network provider",
- "name": "id",
- "type": "string"
- },
- {
"description": "services for this provider",
"name": "servicelist",
"type": "list"
},
{
- "description": "true if individual services can be enabled/disabled",
- "name": "canenableindividualservice",
- "type": "boolean"
- },
- {
"description": "the provider name",
"name": "name",
"type": "string"
},
{
+ "description": "uuid of the network provider",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "true if individual services can be enabled/disabled",
+ "name": "canenableindividualservice",
+ "type": "boolean"
+ },
+ {
"description": "the physical network this belongs to",
"name": "physicalnetworkid",
"type": "string"
@@ -73566,69 +74658,40 @@
}
],
"type": "list"
+ },
+ {
+ "description": "the list of capabilities",
+ "name": "capability",
+ "response": [
+ {
+ "description": "the capability name",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the capability value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "can this service capability value can be choosable while creatine network offerings",
+ "name": "canchooseservicecapability",
+ "type": "boolean"
+ }
+ ],
+ "type": "list"
+ },
+ {
+ "description": "the service name",
+ "name": "name",
+ "type": "string"
}
],
"type": "list"
},
{
- "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": "true if network offering supports vlans, false otherwise",
- "name": "specifyvlan",
- "type": "boolean"
- },
- {
- "description": "data transfer rate in megabits per second allowed.",
- "name": "networkrate",
- "type": "integer"
- },
- {
- "description": "the tags for the network offering",
- "name": "tags",
- "type": "string"
- },
- {
- "description": "availability of the network offering",
- "name": "availability",
- "type": "string"
- },
- {
- "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 id of the network offering",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "an alternate display text of the network offering.",
- "name": "displaytext",
- "type": "string"
- },
- {
- "description": "true if network offering is default, false otherwise",
- "name": "isdefault",
+ "description": "true if network offering is ip conserve mode enabled",
+ "name": "conservemode",
"type": "boolean"
},
{
@@ -73636,37 +74699,13 @@
"name": "ispersistent",
"type": "boolean"
},
- {
- "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "true if network offering supports public access for guest networks",
- "name": "supportspublicaccess",
- "type": "boolean"
- },
- {
- "description": "true if network offering can be used by VPC networks only",
- "name": "forvpc",
- "type": "boolean"
- },
- {
- "description": "the name of the network offering",
- "name": "name",
- "type": "string"
- },
+ {},
{
"description": "the date this network offering was created",
"name": "created",
"type": "date"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
"description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
"name": "zone",
"type": "string"
@@ -73677,28 +74716,23 @@
"type": "string"
},
{
- "description": "state of the network offering. Can be Disabled/Enabled/Inactive",
- "name": "state",
- "type": "string"
- },
- {
"description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
"name": "domain",
"type": "string"
},
{
- "description": "additional key/value details tied with network offering",
- "name": "details",
- "type": "map"
+ "description": "guest type of the network offering, can be Shared or Isolated",
+ "name": "guestiptype",
+ "type": "string"
},
{
- "description": "true if network offering is ip conserve mode enabled",
- "name": "conservemode",
+ "description": "true if network offering is default, false otherwise",
+ "name": "isdefault",
"type": "boolean"
},
{
- "description": "true if network offering supports network that span multiple zones",
- "name": "supportsstrechedl2subnet",
+ "description": "true if network offering supports specifying ip ranges, false otherwise",
+ "name": "specifyipranges",
"type": "boolean"
},
{
@@ -73707,14 +74741,90 @@
"type": "boolean"
},
{
- "description": "the ID of the service offering used by virtual router provider",
- "name": "serviceofferingid",
+ "description": "true if guest network default egress policy is allow; false if default egress policy is deny",
+ "name": "egressdefaultpolicy",
+ "type": "boolean"
+ },
+ {
+ "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.",
+ "name": "traffictype",
"type": "string"
},
{
- "description": "guest type of the network offering, can be Shared or Isolated",
- "name": "guestiptype",
+ "description": "the name of the network offering",
+ "name": "name",
"type": "string"
+ },
+ {},
+ {
+ "description": "true if network offering supports vlans, false otherwise",
+ "name": "specifyvlan",
+ "type": "boolean"
+ },
+ {
+ "description": "true if network offering supports network that span multiple zones",
+ "name": "supportsstrechedl2subnet",
+ "type": "boolean"
+ },
+ {
+ "description": "the id of the network offering",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "an alternate display text of the network offering.",
+ "name": "displaytext",
+ "type": "string"
+ },
+ {
+ "description": "true if network offering can be used by VPC networks only",
+ "name": "forvpc",
+ "type": "boolean"
+ },
+ {
+ "description": "maximum number of concurrents connections to be handled by lb",
+ "name": "maxconnections",
+ "type": "integer"
+ },
+ {
+ "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "true if network offering supports public access for guest networks",
+ "name": "supportspublicaccess",
+ "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": "availability of the network offering",
+ "name": "availability",
+ "type": "string"
+ },
+ {
+ "description": "state of the network offering. Can be Disabled/Enabled/Inactive",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "additional key/value details tied with network offering",
+ "name": "details",
+ "type": "map"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
}
]
},
@@ -73724,6 +74834,13 @@
"name": "listDedicatedPods",
"params": [
{
+ "description": "the name of the account associated with the pod. Must be used with domainId.",
+ "length": 255,
+ "name": "account",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "the ID of the domain associated with the pod",
"length": 255,
"name": "domainid",
@@ -73732,10 +74849,10 @@
"type": "uuid"
},
{
- "description": "the ID of the pod",
+ "description": "list dedicated pods by affinity group",
"length": 255,
- "name": "podid",
- "related": "updatePod,createManagementNetworkIpRange",
+ "name": "affinitygroupid",
+ "related": "",
"required": false,
"type": "uuid"
},
@@ -73747,24 +74864,10 @@
"type": "integer"
},
{
- "description": "",
+ "description": "the ID of the pod",
"length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
- },
- {
- "description": "the name of the account associated with the pod. Must be used with domainId.",
- "length": 255,
- "name": "account",
- "required": false,
- "type": "string"
- },
- {
- "description": "list dedicated pods by affinity group",
- "length": 255,
- "name": "affinitygroupid",
- "related": "",
+ "name": "podid",
+ "related": "updatePod,createManagementNetworkIpRange",
"required": false,
"type": "uuid"
},
@@ -73774,25 +74877,20 @@
"name": "keyword",
"required": false,
"type": "string"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
}
],
"related": "",
"response": [
{
- "description": "the domain ID to which the Pod is dedicated",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the Name of the Pod",
- "name": "podname",
- "type": "string"
- },
- {},
- {},
- {
- "description": "the Dedication Affinity Group ID of the pod",
- "name": "affinitygroupid",
+ "description": "the Account Id to which the Pod is dedicated",
+ "name": "accountid",
"type": "string"
},
{
@@ -73801,24 +74899,36 @@
"type": "string"
},
{
- "description": "the Account Id to which the Pod is dedicated",
- "name": "accountid",
- "type": "string"
- },
- {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
{
+ "description": "the Name of the Pod",
+ "name": "podname",
+ "type": "string"
+ },
+ {
+ "description": "the Dedication Affinity Group ID of the pod",
+ "name": "affinitygroupid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
"description": "the ID of the dedicated resource",
"name": "id",
"type": "string"
},
+ {},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "the domain ID to which the Pod is dedicated",
+ "name": "domainid",
+ "type": "string"
}
]
},
@@ -73854,292 +74964,70 @@
"related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance",
"response": [
{
- "description": "the group ID of the virtual machine",
- "name": "groupid",
- "type": "string"
- },
- {
- "description": "instance name of the user vm; this parameter is returned to the ROOT admin only",
- "name": "instancename",
- "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 availability zone for the virtual machine",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "ssh key-pair",
- "name": "keypair",
- "type": "string"
- },
- {
- "description": "Guest vm Boot Type",
- "name": "boottype",
- "type": "string"
- },
- {
- "description": "the ID of the domain in which the virtual machine exists",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "Vm details in key/value pairs.",
- "name": "details",
- "type": "map"
- },
- {
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
- },
- {
- "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 hypervisor on which the template runs",
"name": "hypervisor",
"type": "string"
},
- {},
{
- "description": "user generated name. The name of the virtual machine is returned if no displayname exists.",
- "name": "displayname",
- "type": "string"
- },
- {
- "description": "Guest vm Boot Mode",
- "name": "bootmode",
- "type": "string"
- },
- {
- "description": "the incoming network traffic on the vm",
- "name": "networkkbsread",
- "type": "long"
- },
- {
- "description": "the name of the host for the virtual machine",
- "name": "hostname",
- "type": "string"
- },
- {
- "description": "the total number of network traffic bytes received",
- "name": "receivedbytes",
- "type": "long"
- },
- {
- "description": "list of affinity groups associated with the virtual machine",
- "name": "affinitygroup",
+ "description": "the list of resource tags associated",
+ "name": "tags",
"response": [
{
- "description": "the domain ID of the affinity group",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the name of the affinity group",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the project ID of the affinity group",
+ "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 description of the affinity group",
- "name": "description",
+ "description": "the project name where tag belongs to",
+ "name": "project",
"type": "string"
},
{
- "description": "the ID of the affinity group",
- "name": "id",
+ "description": "id of the resource",
+ "name": "resourceid",
"type": "string"
},
{
- "description": "the account owning the affinity group",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the type of the affinity group",
- "name": "type",
- "type": "string"
- },
- {
- "description": "the domain name of the affinity group",
+ "description": "the domain associated with the tag",
"name": "domain",
"type": "string"
},
{
- "description": "the project name of the affinity group",
- "name": "project",
+ "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": "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"
}
],
"type": "set"
},
{
- "description": "the virtual network for the service offering",
- "name": "forvirtualnetwork",
- "type": "boolean"
- },
- {
- "description": "the date when this virtual machine was updated last time",
- "name": "lastupdated",
- "type": "date"
- },
- {
- "description": "an optional field whether to the display the vm to the end user or not.",
- "name": "displayvm",
- "type": "boolean"
- },
- {
- "description": "the total number of network traffic bytes sent",
- "name": "sentbytes",
- "type": "long"
- },
- {
- "description": "OS type id of the vm",
- "name": "ostypeid",
- "type": "string"
- },
- {
- "description": "the pool type of the virtual machine",
- "name": "pooltype",
- "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": "the amount of the vm's CPU currently used",
- "name": "cpuused",
- "type": "string"
- },
- {
- "description": "the target memory in vm",
- "name": "memorytargetkbs",
- "type": "long"
- },
- {
- "description": " an alternate display text of the template for the virtual machine",
- "name": "templatedisplaytext",
- "type": "string"
- },
- {
- "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.",
- "name": "templateid",
- "type": "string"
- },
- {
- "description": "true if the password rest feature is enabled, false otherwise",
- "name": "passwordenabled",
- "type": "boolean"
- },
- {
- "description": "an alternate display text of the ISO attached to the virtual machine",
- "name": "isodisplaytext",
- "type": "string"
- },
- {
- "description": "the write (io) of disk on the vm",
- "name": "diskiowrite",
- "type": "long"
- },
- {
- "description": "the internal memory 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",
- "name": "diskofferingname",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the ID of the backup offering of the virtual machine",
- "name": "backupofferingid",
- "type": "string"
- },
- {
- "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.",
- "name": "isdynamicallyscalable",
- "type": "boolean"
- },
- {
- "description": "the outgoing network traffic on the host",
- "name": "networkkbswrite",
- "type": "long"
- },
- {
- "description": "the vgpu type used by the virtual machine",
- "name": "vgpu",
- "type": "string"
- },
- {
- "description": "the write (bytes) of disk on the vm",
- "name": "diskkbswrite",
- "type": "long"
- },
- {
- "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": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "the name of the backup offering of the virtual machine",
- "name": "backupofferingname",
- "type": "string"
- },
- {},
- {
- "description": "the memory used by the vm",
- "name": "memorykbs",
+ "description": "the read (io) of disk on the vm",
+ "name": "diskioread",
"type": "long"
},
{
@@ -74148,38 +75036,43 @@
"type": "string"
},
{
- "description": "the ID of the disk offering of the virtual machine",
- "name": "diskofferingid",
+ "description": "the outgoing network traffic on the host",
+ "name": "networkkbswrite",
+ "type": "long"
+ },
+ {
+ "description": "the name of the template for the virtual machine",
+ "name": "templatename",
"type": "string"
},
{
- "description": "the date when this virtual machine was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "device type of the root volume",
- "name": "rootdevicetype",
+ "description": "Os type ID of the virtual machine",
+ "name": "guestosid",
"type": "string"
},
{
- "description": "the ID of the virtual machine",
- "name": "id",
+ "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.",
+ "name": "isdynamicallyscalable",
+ "type": "boolean"
+ },
+ {
+ "description": "the name of the disk offering of the virtual machine",
+ "name": "diskofferingname",
"type": "string"
},
{
- "description": "the speed of each cpu",
- "name": "cpuspeed",
- "type": "integer"
- },
- {
- "description": "the project name of the vm",
- "name": "project",
+ "description": "the password (if exists) of the virtual machine",
+ "name": "password",
"type": "string"
},
{
- "description": "the user's ID who deployed the virtual machine",
- "name": "userid",
+ "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"
},
{
@@ -74188,33 +75081,514 @@
"type": "boolean"
},
{
- "description": "State of the Service from LB rule",
- "name": "servicestate",
+ "description": "the speed of each cpu",
+ "name": "cpuspeed",
+ "type": "integer"
+ },
+ {
+ "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 name of the virtual machine",
+ "name": "group",
+ "type": "string"
+ },
+ {
+ "description": "the number of cpu this virtual machine is running with",
+ "name": "cpunumber",
+ "type": "integer"
+ },
+ {
+ "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",
+ "type": "string"
+ },
+ {
+ "description": "the name of the ISO attached to the virtual machine",
+ "name": "isoname",
+ "type": "string"
+ },
+ {
+ "description": "the internal memory that's free in vm or zero if it can not be calculated",
+ "name": "memoryintfreekbs",
+ "type": "long"
+ },
+ {
+ "description": "the date when this virtual machine was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.",
+ "name": "templateid",
+ "type": "string"
+ },
+ {
+ "description": "device type of the root volume",
+ "name": "rootdevicetype",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the backup offering of the virtual machine",
+ "name": "backupofferingid",
+ "type": "string"
+ },
+ {
+ "description": "the target memory in vm",
+ "name": "memorytargetkbs",
+ "type": "long"
+ },
+ {
"description": "the memory allocated for the virtual machine",
"name": "memory",
"type": "integer"
},
{
- "description": "the read (io) of disk on the vm",
- "name": "diskioread",
+ "description": "the name of the backup offering of the virtual machine",
+ "name": "backupofferingname",
+ "type": "string"
+ },
+ {
+ "description": "the total number of network traffic bytes sent",
+ "name": "sentbytes",
"type": "long"
},
{
- "description": "OS name of the vm",
- "name": "osdisplayname",
+ "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",
+ "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 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": "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 ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the id of the security group rule",
+ "name": "ruleid",
+ "type": "string"
+ },
+ {
+ "description": "the CIDR notation for the base IP address of the security group rule",
+ "name": "cidr",
+ "type": "string"
+ },
+ {
+ "description": "the starting IP of the security group rule",
+ "name": "startport",
+ "type": "integer"
+ },
+ {
+ "description": "security group name",
+ "name": "securitygroupname",
+ "type": "string"
+ },
+ {
+ "description": "the ending IP of the security group rule ",
+ "name": "endport",
+ "type": "integer"
+ },
+ {
+ "description": "account owning the security group rule",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the type of the ICMP message response",
+ "name": "icmptype",
+ "type": "integer"
+ },
+ {
+ "description": "the code for the ICMP message response",
+ "name": "icmpcode",
+ "type": "integer"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the project id of the group",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID of the security group",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the domain name of the security group",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the name of the security group",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the 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 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 list of resource tags associated with the rule",
+ "name": "tags",
+ "response": [
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "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": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "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",
+ "type": "integer"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the list of resource tags associated with the rule",
+ "name": "tags",
+ "response": [
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the 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"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the account owning the security group",
+ "name": "account",
+ "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 number of virtualmachines associated with this securitygroup",
+ "name": "virtualmachinecount",
+ "type": "integer"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the write (bytes) of disk on the vm",
+ "name": "diskkbswrite",
+ "type": "long"
+ },
+ {
+ "description": "instance name of the user vm; this parameter is returned to the ROOT admin only",
+ "name": "instancename",
"type": "string"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "State of the Service from LB rule",
+ "name": "servicestate",
+ "type": "string"
+ },
+ {},
+ {},
+ {
+ "description": "the incoming network traffic on the vm",
+ "name": "networkkbsread",
+ "type": "long"
+ },
+ {
+ "description": "the account associated with the virtual machine",
+ "name": "account",
"type": "string"
},
{
- "description": "the ID of the availablility zone for the virtual machine",
- "name": "zoneid",
+ "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 ID of the affinity group",
+ "name": "id",
+ "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": "the project ID of the affinity group",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the description of the affinity group",
+ "name": "description",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the affinity group",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the type of the affinity group",
+ "name": "type",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID of the affinity group",
+ "name": "domainid",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the name of the domain in which the virtual machine exists",
+ "name": "domain",
"type": "string"
},
{
@@ -74222,9 +75596,9 @@
"name": "nic",
"response": [
{
- "description": "the type of the nic",
- "name": "type",
- "type": "string"
+ "description": "IP addresses associated with NIC found for unmanaged VM",
+ "name": "ipaddresses",
+ "type": "list"
},
{
"description": "the gateway of the nic",
@@ -74232,68 +75606,13 @@
"type": "string"
},
{
- "description": "the isolated private VLAN if available",
- "name": "isolatedpvlan",
- "type": "integer"
- },
- {
- "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 isolation uri of the nic",
- "name": "isolationuri",
- "type": "string"
- },
- {
- "description": "the ID of the nic",
- "name": "id",
- "type": "string"
- },
- {
- "description": "device id for the network when plugged into the virtual machine",
- "name": "deviceid",
- "type": "string"
- },
- {
- "description": "Id of the vm to which the nic belongs",
- "name": "virtualmachineid",
- "type": "string"
- },
- {
- "description": "the traffic type of the nic",
- "name": "traffictype",
- "type": "string"
- },
- {
"description": "the cidr of IPv6 network",
"name": "ip6cidr",
"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": "the ID of the corresponding network",
- "name": "networkid",
- "type": "string"
- },
- {
- "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise",
- "name": "nsxlogicalswitchport",
+ "description": "Id of the NSX Logical Switch (if NSX based), null otherwise",
+ "name": "nsxlogicalswitch",
"type": "string"
},
{
@@ -74302,16 +75621,6 @@
"type": "string"
},
{
- "description": "the gateway of IPv6 network",
- "name": "ip6gateway",
- "type": "string"
- },
- {
- "description": "Type of adapter if available",
- "name": "adaptertype",
- "type": "string"
- },
- {
"description": "the isolated private VLAN type if available",
"name": "isolatedpvlantype",
"type": "string"
@@ -74322,19 +75631,29 @@
"type": "list"
},
{
- "description": "the ip address of the nic",
- "name": "ipaddress",
+ "description": "true if nic is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {
+ "description": "the ID of the corresponding network",
+ "name": "networkid",
"type": "string"
},
{
- "description": "the Secondary ipv4 addr of nic",
- "name": "secondaryip",
- "type": "list"
+ "description": "the broadcast uri of the nic",
+ "name": "broadcasturi",
+ "type": "string"
},
{
- "description": "ID of the VLAN/VNI if available",
- "name": "vlanid",
- "type": "integer"
+ "description": "the IPv6 address of network",
+ "name": "ip6address",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the nic",
+ "name": "id",
+ "type": "string"
},
{
"description": "the netmask of the nic",
@@ -74342,446 +75661,76 @@
"type": "string"
},
{
- "description": "true if nic is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
+ "description": "the ip address of the nic",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "the type of the nic",
+ "name": "type",
+ "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 traffic type of the nic",
+ "name": "traffictype",
+ "type": "string"
+ },
+ {
+ "description": "Id of the vm to which the nic belongs",
+ "name": "virtualmachineid",
+ "type": "string"
+ },
+ {
+ "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise",
+ "name": "nsxlogicalswitchport",
+ "type": "string"
+ },
+ {
+ "description": "ID of the VLAN/VNI if available",
+ "name": "vlanid",
+ "type": "integer"
},
{
"description": "true if nic is default, false otherwise",
"name": "macaddress",
"type": "string"
+ },
+ {
+ "description": "Type of adapter if available",
+ "name": "adaptertype",
+ "type": "string"
+ },
+ {
+ "description": "device id for the network when plugged into the virtual machine",
+ "name": "deviceid",
+ "type": "string"
+ },
+ {
+ "description": "the isolation uri of the nic",
+ "name": "isolationuri",
+ "type": "string"
+ },
+ {
+ "description": "the Secondary ipv4 addr of nic",
+ "name": "secondaryip",
+ "type": "list"
}
],
"type": "set"
},
{
- "description": "Os type ID of the virtual machine",
- "name": "guestosid",
- "type": "string"
- },
- {
- "description": "public IP address id associated with vm via Static nat rule",
- "name": "publicipid",
- "type": "string"
- },
- {
- "description": "the list of resource tags associated",
- "name": "tags",
- "response": [
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "list of security groups associated with the virtual machine",
- "name": "securitygroup",
- "response": [
- {
- "description": "the project name of the group",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the description of the security group",
- "name": "description",
- "type": "string"
- },
- {
- "description": "the list of virtualmachine ids associated with this securitygroup",
- "name": "virtualmachineids",
- "type": "set"
- },
- {
- "description": "the ID of the security group",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the 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": "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 code for the ICMP message response",
- "name": "icmpcode",
- "type": "integer"
- },
- {
- "description": "the list of resource tags associated with the rule",
- "name": "tags",
- "response": [
- {
- "description": "the account associated with the tag",
- "name": "account",
- "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"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the ending IP of the security group rule ",
- "name": "endport",
- "type": "integer"
- },
- {
- "description": "the 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 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"
- },
- {
- "description": "the protocol of the security group rule",
- "name": "protocol",
- "type": "string"
- },
- {
- "description": "security group name",
- "name": "securitygroupname",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the project id of the group",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the list of ingress rules associated with the security group",
- "name": "ingressrule",
- "response": [
- {
- "description": "security group name",
- "name": "securitygroupname",
- "type": "string"
- },
- {
- "description": "the id of the security group rule",
- "name": "ruleid",
- "type": "string"
- },
- {
- "description": "the code for the ICMP message response",
- "name": "icmpcode",
- "type": "integer"
- },
- {
- "description": "the 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": "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": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the type of the ICMP message response",
- "name": "icmptype",
- "type": "integer"
- },
- {
- "description": "the starting IP of the security group rule",
- "name": "startport",
- "type": "integer"
- },
- {
- "description": "the CIDR notation for the base IP address of the security group rule",
- "name": "cidr",
- "type": "string"
- },
- {
- "description": "the protocol of the security group rule",
- "name": "protocol",
- "type": "string"
- },
- {
- "description": "account owning the security group rule",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the ending IP of the security group rule ",
- "name": "endport",
- "type": "integer"
- }
- ],
- "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": "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": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the account owning the security group",
- "name": "account",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "public IP address id associated with vm via Static nat rule",
- "name": "publicip",
- "type": "string"
- },
- {
- "description": "the read (bytes) of disk on the vm",
- "name": "diskkbsread",
- "type": "long"
- },
- {},
- {
- "description": "the name of the ISO attached to the virtual machine",
- "name": "isoname",
- "type": "string"
- },
- {
- "description": "List of read-only Vm details as comma separated string.",
- "name": "readonlydetails",
- "type": "string"
- },
- {
- "description": "the account associated with the virtual machine",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the ID of the host for the virtual machine",
- "name": "hostid",
+ "description": "OS name of the vm",
+ "name": "osdisplayname",
"type": "string"
},
{
@@ -74790,18 +75739,179 @@
"type": "string"
},
{
+ "description": "the user's name who deployed the virtual machine",
+ "name": "username",
+ "type": "string"
+ },
+ {
"description": "the state of the virtual machine",
"name": "state",
"type": "string"
},
{
- "description": "the number of cpu this virtual machine is running with",
- "name": "cpunumber",
+ "description": "the project name of the vm",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "public IP address id associated with vm via Static nat rule",
+ "name": "publicip",
+ "type": "string"
+ },
+ {
+ "description": "the user's ID who deployed the virtual machine",
+ "name": "userid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the virtual machine",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "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": "the read (bytes) of disk on the vm",
+ "name": "diskkbsread",
+ "type": "long"
+ },
+ {
+ "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": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "description": "OS type id of the vm",
+ "name": "ostypeid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the group ID of the virtual machine",
+ "name": "groupid",
+ "type": "string"
+ },
+ {
+ "description": "Vm details in key/value pairs.",
+ "name": "details",
+ "type": "map"
+ },
+ {
+ "description": "the pool type of the virtual machine",
+ "name": "pooltype",
+ "type": "string"
+ },
+ {
+ "description": "the total number of network traffic bytes received",
+ "name": "receivedbytes",
+ "type": "long"
+ },
+ {
+ "description": "an alternate display text of the ISO attached to the virtual machine",
+ "name": "isodisplaytext",
+ "type": "string"
+ },
+ {
+ "description": "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": "the name of the availability zone for the virtual machine",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "ssh key-pair",
+ "name": "keypair",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the disk offering of the virtual machine",
+ "name": "diskofferingid",
+ "type": "string"
+ },
+ {
+ "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": "true if the password rest feature is enabled, false otherwise",
+ "name": "passwordenabled",
+ "type": "boolean"
+ },
+ {
+ "description": "the vgpu type used by the virtual machine",
+ "name": "vgpu",
+ "type": "string"
+ },
+ {
+ "description": " an alternate display text of the template for the virtual machine",
+ "name": "templatedisplaytext",
+ "type": "string"
+ },
+ {
+ "description": "the name of the host for the virtual machine",
+ "name": "hostname",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the availablility zone for the virtual machine",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
"type": "integer"
},
{
- "description": "the name of the template for the virtual machine",
- "name": "templatename",
+ "description": "the memory used by the vm",
+ "name": "memorykbs",
+ "type": "long"
+ },
+ {
+ "description": "user generated name. The name of the virtual machine is returned if no displayname exists.",
+ "name": "displayname",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain in which the virtual machine exists",
+ "name": "domainid",
"type": "string"
}
]
@@ -74812,18 +75922,18 @@
"name": "listVPCs",
"params": [
{
- "description": "list resources by account. Must be used with the domainId parameter.",
+ "description": "List by display text of the VPC",
"length": 255,
- "name": "account",
+ "name": "displaytext",
"required": false,
"type": "string"
},
{
- "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",
@@ -74833,21 +75943,6 @@
"type": "boolean"
},
{
- "description": "list by zone",
- "length": 255,
- "name": "zoneid",
- "related": "createZone,listZones,listZones",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "",
- "length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
- },
- {
"description": "list VPC by id",
"length": 255,
"name": "id",
@@ -74856,6 +75951,13 @@
"type": "uuid"
},
{
+ "description": "flag to display the resource icon for VPCs",
+ "length": 255,
+ "name": "showicon",
+ "required": false,
+ "type": "boolean"
+ },
+ {
"description": "list by cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR",
"length": 255,
"name": "cidr",
@@ -74863,43 +75965,6 @@
"type": "string"
},
{
- "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
- "length": 255,
- "name": "isrecursive",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "list by name of the VPC",
- "length": 255,
- "name": "name",
- "required": false,
- "type": "string"
- },
- {
- "description": "list only resources belonging to the domain specified",
- "length": 255,
- "name": "domainid",
- "related": "listDomainChildren,listDomains",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "",
- "length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
- },
- {
- "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter",
- "length": 255,
- "name": "fordisplay",
- "required": false,
- "since": "4.4",
- "type": "boolean"
- },
- {
"description": "list by ID of the VPC offering",
"length": 255,
"name": "vpcofferingid",
@@ -74908,18 +75973,26 @@
"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": "flag to display the resource icon for VPCs",
+ "description": "list VPC supporting certain services",
"length": 255,
- "name": "showicon",
+ "name": "supportedservices",
"required": false,
- "type": "boolean"
+ "type": "list"
+ },
+ {
+ "description": "List resources by tags (key/value pairs)",
+ "length": 255,
+ "name": "tags",
+ "required": false,
+ "type": "map"
},
{
"description": "list objects by project",
@@ -74930,9 +76003,9 @@
"type": "uuid"
},
{
- "description": "List by display text of the VPC",
+ "description": "list by name of the VPC",
"length": 255,
- "name": "displaytext",
+ "name": "name",
"required": false,
"type": "string"
},
@@ -74944,180 +76017,77 @@
"type": "boolean"
},
{
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
+ "length": 255,
+ "name": "isrecursive",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "list only resources belonging to the domain specified",
+ "length": 255,
+ "name": "domainid",
+ "related": "listDomainChildren,listDomains",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "list resources by account. Must be used with the domainId parameter.",
+ "length": 255,
+ "name": "account",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "list by zone",
+ "length": 255,
+ "name": "zoneid",
+ "related": "createZone,listZones,listZones",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "list VPCs by state",
"length": 255,
"name": "state",
"required": false,
"type": "string"
- },
- {
- "description": "list VPC supporting certain services",
- "length": 255,
- "name": "supportedservices",
- "required": false,
- "type": "list"
}
],
"related": "createVPC,listVPCs,updateVPC,migrateVPC",
"response": [
{
- "description": "the domain name of the owner",
- "name": "domain",
+ "description": "the project id of the VPC",
+ "name": "projectid",
"type": "string"
},
{
- "description": "vpc offering name the VPC is created from",
- "name": "vpcofferingname",
+ "description": "the network domain of the VPC",
+ "name": "networkdomain",
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's",
- "name": "distributedvpcrouter",
- "type": "boolean"
- },
- {
- "description": "the cidr the VPC",
- "name": "cidr",
- "type": "string"
- },
- {},
- {
- "description": "the owner of the VPC",
- "name": "account",
- "type": "string"
- },
- {
- "description": "vpc offering id the VPC is created from",
- "name": "vpcofferingid",
- "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 date this VPC was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "state of the VPC. Can be Inactive/Enabled",
- "name": "state",
- "type": "string"
- },
- {
- "description": "the list of resource tags associated with the project",
- "name": "tags",
- "response": [
- {
- "description": "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"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "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": "list"
- },
- {
"description": "the list of supported services",
"name": "service",
"response": [
{
- "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": "state of the network provider",
- "name": "state",
- "type": "string"
- },
- {
- "description": "the provider name",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the physical network this belongs to",
- "name": "physicalnetworkid",
- "type": "string"
- },
- {
- "description": "uuid of the network provider",
- "name": "id",
- "type": "string"
- },
- {
- "description": "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",
@@ -75142,41 +76112,63 @@
"type": "list"
},
{
- "description": "the service name",
- "name": "name",
- "type": "string"
+ "description": "the service provider name",
+ "name": "provider",
+ "response": [
+ {
+ "description": "the physical network this belongs to",
+ "name": "physicalnetworkid",
+ "type": "string"
+ },
+ {
+ "description": "the destination physical network",
+ "name": "destinationphysicalnetworkid",
+ "type": "string"
+ },
+ {
+ "description": "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": "uuid of the network provider",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "state of the network provider",
+ "name": "state",
+ "type": "string"
+ }
+ ],
+ "type": "list"
}
],
"type": "list"
},
{
- "description": "an alternate display text of the VPC.",
- "name": "displaytext",
- "type": "string"
- },
- {
- "description": "true if VPC is region level",
- "name": "regionlevelvpc",
+ "description": "if this VPC has redundant router",
+ "name": "redundantvpcrouter",
"type": "boolean"
},
{
- "description": "zone id of the vpc",
- "name": "zoneid",
- "type": "string"
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
},
{
- "description": "the name of the VPC",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the project id of the VPC",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the domain id of the VPC owner",
- "name": "domainid",
+ "description": "the domain name of the owner",
+ "name": "domain",
"type": "string"
},
{
@@ -75185,29 +76177,91 @@
"type": "resourceiconresponse"
},
{
+ "description": "vpc offering id the VPC is created from",
+ "name": "vpcofferingid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the VPC",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "zone id of the vpc",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
"description": "the project name of the VPC",
"name": "project",
"type": "string"
},
{
- "description": "the name of the zone the VPC belongs to",
- "name": "zonename",
- "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": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ }
+ ],
+ "type": "list"
},
{},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "state of the VPC. Can be Inactive/Enabled",
+ "name": "state",
"type": "string"
},
{
- "description": "if this VPC has redundant router",
- "name": "redundantvpcrouter",
+ "description": "is vpc for display to the regular user",
+ "name": "fordisplay",
"type": "boolean"
},
{
@@ -75216,13 +76270,69 @@
"type": "boolean"
},
{
- "description": "is vpc for display to the regular user",
- "name": "fordisplay",
+ "description": "the domain id of the VPC owner",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the owner of the VPC",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "true if VPC is region level",
+ "name": "regionlevelvpc",
"type": "boolean"
},
{
- "description": "the network domain of the VPC",
- "name": "networkdomain",
+ "description": "the id of the VPC",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the name of the zone the VPC belongs to",
+ "name": "zonename",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the list of networks belongign to the VPC",
+ "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": "is VPC uses distributed router for one hop forwarding and host based network ACL's",
+ "name": "distributedvpcrouter",
+ "type": "boolean"
+ },
+ {
+ "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 cidr the VPC",
+ "name": "cidr",
+ "type": "string"
+ },
+ {
+ "description": "an alternate display text of the VPC.",
+ "name": "displaytext",
"type": "string"
}
]
@@ -75233,18 +76343,18 @@
"name": "addNetworkDevice",
"params": [
{
- "description": "Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall",
- "length": 255,
- "name": "networkdevicetype",
- "required": false,
- "type": "string"
- },
- {
"description": "parameters for network device",
"length": 255,
"name": "networkdeviceparameterlist",
"required": false,
"type": "map"
+ },
+ {
+ "description": "Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall",
+ "length": 255,
+ "name": "networkdevicetype",
+ "required": false,
+ "type": "string"
}
],
"related": "",
@@ -75255,17 +76365,17 @@
"name": "id",
"type": "string"
},
- {},
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- }
+ {}
]
},
{
@@ -75274,21 +76384,6 @@
"name": "runDiagnostics",
"params": [
{
- "description": "The ID of the system VM instance to diagnose",
- "length": 255,
- "name": "targetid",
- "related": "migrateSystemVm,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 IP/Domain address to test connection to",
"length": 255,
"name": "ipaddress",
@@ -75301,23 +76396,27 @@
"name": "type",
"required": true,
"type": "string"
+ },
+ {
+ "description": "Additional command line options that apply for each command",
+ "length": 255,
+ "name": "params",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "The ID of the system VM instance to diagnose",
+ "length": 255,
+ "name": "targetid",
+ "related": "migrateSystemVm,startSystemVm",
+ "required": true,
+ "type": "uuid"
}
],
"related": "",
"response": [
{},
{
- "description": "the standard error output from the command execution",
- "name": "stderr",
- "type": "string"
- },
- {},
- {
- "description": "the command execution return code",
- "name": "exitcode",
- "type": "string"
- },
- {
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
@@ -75328,9 +76427,20 @@
"type": "string"
},
{
+ "description": "the standard error output from the command execution",
+ "name": "stderr",
+ "type": "string"
+ },
+ {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
+ },
+ {},
+ {
+ "description": "the command execution return code",
+ "name": "exitcode",
+ "type": "string"
}
],
"since": "4.12.0.0"
@@ -75341,9 +76451,9 @@
"name": "updateUser",
"params": [
{
- "description": "email",
+ "description": "last name",
"length": 255,
- "name": "email",
+ "name": "lastname",
"required": false,
"type": "string"
},
@@ -75355,34 +76465,6 @@
"type": "string"
},
{
- "description": "The API key for the user. Must be specified with userSecretKey",
- "length": 255,
- "name": "userapikey",
- "required": false,
- "type": "string"
- },
- {
- "description": "Unique username",
- "length": 255,
- "name": "username",
- "required": false,
- "type": "string"
- },
- {
- "description": "Current password that was being used by the user. You must inform the current password when updating the password.",
- "length": 255,
- "name": "currentpassword",
- "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"
- },
- {
"description": "User uuid",
"length": 255,
"name": "id",
@@ -75391,16 +76473,30 @@
"type": "uuid"
},
{
- "description": "last name",
+ "description": "Unique username",
"length": 255,
- "name": "lastname",
+ "name": "username",
"required": false,
"type": "string"
},
{
- "description": "first name",
+ "description": "email",
"length": 255,
- "name": "firstname",
+ "name": "email",
+ "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"
+ },
+ {
+ "description": "Current password that was being used by the user. You must inform the current password when updating the password.",
+ "length": 255,
+ "name": "currentpassword",
"required": false,
"type": "string"
},
@@ -75410,95 +76506,82 @@
"name": "timezone",
"required": false,
"type": "string"
+ },
+ {
+ "description": "The API key for the user. Must be specified with userSecretKey",
+ "length": 255,
+ "name": "userapikey",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "first name",
+ "length": 255,
+ "name": "firstname",
+ "required": false,
+ "type": "string"
}
],
"related": "createUser,disableUser,enableUser,getUser,listUsers",
"response": [
- {},
{
- "description": "the user state",
- "name": "state",
+ "description": "the ID of the role",
+ "name": "roleid",
"type": "string"
},
{
- "description": "the account ID of the user",
- "name": "accountid",
- "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 is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
- },
- {},
- {
- "description": "the user ID",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the date and time the user account was created",
- "name": "created",
- "type": "date"
- },
- {
"description": "the secret key of the user",
"name": "secretkey",
"type": "string"
},
{
- "description": "the api key of the user",
- "name": "apikey",
- "type": "string"
- },
- {
- "description": "the ID of the role",
- "name": "roleid",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
"description": "the type of the role",
"name": "roletype",
"type": "string"
},
{
- "description": "the name of the role",
- "name": "rolename",
- "type": "string"
- },
- {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
{
- "description": "the user name",
- "name": "username",
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "description": "the user email address",
+ "name": "email",
"type": "string"
},
{
- "description": "the source type of the user in lowercase, such as native, ldap, saml2",
- "name": "usersource",
+ "description": "true if user is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {
+ "description": "the user ID",
+ "name": "id",
"type": "string"
},
{
- "description": "the user lastname",
- "name": "lastname",
+ "description": "the domain ID of the user",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the account type of the user",
+ "name": "accounttype",
+ "type": "short"
+ },
+ {
+ "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"
},
{
@@ -75507,35 +76590,62 @@
"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",
+ "type": "string"
},
{
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
+ "description": "the user lastname",
+ "name": "lastname",
+ "type": "string"
},
{
- "description": "the account type of the user",
- "name": "accounttype",
- "type": "short"
+ "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 source type of the user in lowercase, such as native, ldap, saml2",
+ "name": "usersource",
+ "type": "string"
+ },
+ {
+ "description": "the api key of the user",
+ "name": "apikey",
+ "type": "string"
+ },
+ {
"description": "the domain name of the user",
"name": "domain",
"type": "string"
},
{
- "description": "the user email address",
- "name": "email",
+ "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",
+ "name": "rolename",
+ "type": "string"
+ },
+ {
+ "description": "the account ID of the user",
+ "name": "accountid",
+ "type": "string"
+ },
+ {}
]
},
{
@@ -75544,6 +76654,13 @@
"name": "restartVPC",
"params": [
{
+ "description": "Turn a single VPC into a redundant one.",
+ "length": 255,
+ "name": "makeredundant",
+ "required": false,
+ "type": "boolean"
+ },
+ {
"description": "the id of the VPC",
"length": 255,
"name": "id",
@@ -75557,37 +76674,30 @@
"name": "cleanup",
"required": false,
"type": "boolean"
- },
- {
- "description": "Turn a single VPC into a redundant one.",
- "length": 255,
- "name": "makeredundant",
- "required": false,
- "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": "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"
}
]
},
@@ -75606,27 +76716,27 @@
}
],
"response": [
- {},
{
- "description": "any text associated with the success or failure",
- "name": "displaytext",
- "type": "string"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
{
"description": "true if operation is executed successfully",
"name": "success",
"type": "boolean"
},
- {},
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
+ {},
+ {},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "any text associated with the success or failure",
+ "name": "displaytext",
+ "type": "string"
}
]
},
@@ -75644,6 +76754,50 @@
"type": "uuid"
},
{
+ "description": "Allocation state of this Host for allocation of new resources",
+ "length": 255,
+ "name": "allocationstate",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the username for the host; required to be passed for hypervisors other than VMWare",
+ "length": 255,
+ "name": "username",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the cluster ID for the host",
+ "length": 255,
+ "name": "clusterid",
+ "related": "addCluster",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "the host URL",
+ "length": 255,
+ "name": "url",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "the Pod ID for the host",
+ "length": 255,
+ "name": "podid",
+ "related": "updatePod,createManagementNetworkIpRange",
+ "required": true,
+ "type": "uuid"
+ },
+ {
+ "description": "list of tags to be added to the host",
+ "length": 255,
+ "name": "hosttags",
+ "required": false,
+ "type": "list"
+ },
+ {
"description": "the cluster name for the host",
"length": 255,
"name": "clustername",
@@ -75658,50 +76812,6 @@
"type": "string"
},
{
- "description": "Allocation state of this Host for allocation of new resources",
- "length": 255,
- "name": "allocationstate",
- "required": false,
- "type": "string"
- },
- {
- "description": "the host URL",
- "length": 255,
- "name": "url",
- "required": true,
- "type": "string"
- },
- {
- "description": "the username for the host; required to be passed for hypervisors other than VMWare",
- "length": 255,
- "name": "username",
- "required": false,
- "type": "string"
- },
- {
- "description": "the Pod ID for the host",
- "length": 255,
- "name": "podid",
- "related": "updatePod,createManagementNetworkIpRange",
- "required": true,
- "type": "uuid"
- },
- {
- "description": "the cluster ID for the host",
- "length": 255,
- "name": "clusterid",
- "related": "addCluster",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "list of tags to be added to the host",
- "length": 255,
- "name": "hosttags",
- "required": false,
- "type": "list"
- },
- {
"description": "the password for the host; required to be passed for hypervisors other than VMWare",
"length": 255,
"name": "password",
@@ -75712,169 +76822,14 @@
"related": "cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost",
"response": [
{
- "description": "the OS category name of the host",
- "name": "oscategoryname",
- "type": "string"
- },
- {
- "description": "the cluster type of the cluster that host belongs to",
- "name": "clustertype",
- "type": "string"
- },
- {
- "description": "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 after applying the cpu.overprovisioning.factor",
- "name": "cpuwithoverprovisioning",
- "type": "string"
- },
- {
- "description": "the amount of the host's memory after applying the mem.overprovisioning.factor",
- "name": "memorywithoverprovisioning",
- "type": "string"
- },
- {
- "description": "the OS category ID of the host",
- "name": "oscategoryid",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor",
- "name": "cpuallocatedwithoverprovisioning",
- "type": "string"
- },
- {
- "description": "the Pod name of the host",
- "name": "podname",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "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 cluster ID of the host",
- "name": "clusterid",
- "type": "string"
- },
- {
- "description": "the Pod ID of the host",
- "name": "podid",
- "type": "string"
- },
- {
- "description": "events available for the host",
- "name": "events",
- "type": "string"
- },
- {
- "description": "the host's currently allocated disk size",
- "name": "disksizeallocated",
- "type": "long"
- },
- {
- "description": "the host hypervisor",
- "name": "hypervisor",
- "type": "hypervisortype"
- },
- {
"description": "the number of CPU sockets on the host",
"name": "cpusockets",
"type": "integer"
},
+ {},
{
- "description": "true if the host is disconnected. False otherwise.",
- "name": "disconnected",
- "type": "date"
- },
- {
- "description": "the name of the host",
- "name": "name",
- "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": "the amount of the host's memory currently allocated in percentage",
- "name": "memoryallocatedpercentage",
- "type": "string"
- },
- {
- "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 admin that annotated this host",
- "name": "username",
- "type": "string"
- },
- {
- "description": "the amount of the host's CPU currently allocated",
- "name": "cpuallocated",
- "type": "string"
- },
- {
- "description": "the date and time the host was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the outgoing network traffic on the host",
- "name": "networkkbswrite",
- "type": "long"
- },
- {
- "description": "the incoming network traffic on the host",
- "name": "networkkbsread",
- "type": "long"
- },
- {
- "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 last annotation set on this host by an admin",
- "name": "annotation",
+ "description": "the Pod name of the host",
+ "name": "podname",
"type": "string"
},
{
@@ -75883,53 +76838,33 @@
"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",
- "type": "string"
- },
- {
- "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": "capabilities of the host",
"name": "capabilities",
"type": "string"
},
{
- "description": "the host version",
- "name": "version",
- "type": "string"
- },
- {
"description": "the Zone ID of the host",
"name": "zoneid",
"type": "string"
},
{
- "description": "the cluster name of the host",
- "name": "clustername",
- "type": "string"
+ "description": "the last time this host was annotated",
+ "name": "lastannotated",
+ "type": "date"
},
{
- "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning",
- "name": "memorytotal",
+ "description": "true if the host is disconnected. False otherwise.",
+ "name": "disconnected",
+ "type": "date"
+ },
+ {
+ "description": "the outgoing network traffic on the host",
+ "name": "networkkbswrite",
"type": "long"
},
{
- "description": "the last time this host was annotated",
- "name": "lastannotated",
+ "description": "the date and time the host was created",
+ "name": "created",
"type": "date"
},
{
@@ -75938,54 +76873,24 @@
"type": "boolean"
},
{
- "description": "the host HA information information",
- "name": "hostha",
- "type": "hostharesponse"
- },
- {
- "description": "the host out-of-band management information",
- "name": "outofbandmanagement",
- "type": "outofbandmanagementresponse"
- },
- {
- "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": "Host details in key/value pairs.",
- "name": "details",
- "type": "map"
- },
- {
- "description": "the hypervisor version",
- "name": "hypervisorversion",
- "type": "string"
- },
- {
- "description": "the ID of the host",
- "name": "id",
- "type": "string"
- },
- {
"description": "the CPU number of the host",
"name": "cpunumber",
"type": "integer"
},
{
- "description": "true if the host has capability to support UEFI boot",
- "name": "ueficapability",
- "type": "boolean"
+ "description": "the cluster ID of the host",
+ "name": "clusterid",
+ "type": "string"
},
{
- "description": "the amount of the host's memory currently allocated",
- "name": "memoryallocated",
- "type": "long"
- },
- {
- "description": "the amount of the host's CPU currently allocated in MHz",
- "name": "cpuallocatedvalue",
- "type": "long"
+ "description": "comma-separated list of tags for the host",
+ "name": "hosttags",
+ "type": "string"
},
{
"description": "the state of the host",
@@ -75993,6 +76898,11 @@
"type": "status"
},
{
+ "description": "the amount of the host's memory after applying the mem.overprovisioning.factor",
+ "name": "memorywithoverprovisioning",
+ "type": "string"
+ },
+ {
"description": "GPU cards present in the host",
"name": "gpugroup",
"response": [
@@ -76006,38 +76916,38 @@
"type": "long"
},
{
+ "description": "Maximum Y resolution per display",
+ "name": "maxresolutiony",
+ "type": "long"
+ },
+ {
+ "description": "Maximum vgpu can be created with this vgpu type on the given gpu group",
+ "name": "maxcapacity",
+ "type": "long"
+ },
+ {
"description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type",
"name": "remainingcapacity",
"type": "long"
},
{
- "description": "Maximum displays per user",
- "name": "maxheads",
- "type": "long"
- },
- {
- "description": "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": "Maximum no. of vgpu per gpu card (pgpu)",
"name": "maxvgpuperpgpu",
"type": "long"
},
{
- "description": "Maximum vgpu can be created with this vgpu type on the given gpu group",
- "name": "maxcapacity",
+ "description": "Video RAM for this vGPU type",
+ "name": "videoram",
+ "type": "long"
+ },
+ {
+ "description": "Maximum displays per user",
+ "name": "maxheads",
"type": "long"
}
],
@@ -76051,11 +76961,35 @@
],
"type": "list"
},
- {},
{
- "description": "the amount of the host's memory currently used",
- "name": "memoryused",
- "type": "long"
+ "description": "the OS category name of the host",
+ "name": "oscategoryname",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the host's CPU currently allocated",
+ "name": "cpuallocated",
+ "type": "string"
+ },
+ {
+ "description": "the host hypervisor",
+ "name": "hypervisor",
+ "type": "hypervisortype"
+ },
+ {
+ "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",
+ "type": "string"
+ },
+ {
+ "description": "events available for the host",
+ "name": "events",
+ "type": "string"
},
{
"description": "the resource state of the host",
@@ -76063,14 +76997,190 @@
"type": "string"
},
{
+ "description": "the host out-of-band management information",
+ "name": "outofbandmanagement",
+ "type": "outofbandmanagementresponse"
+ },
+ {
+ "description": "the Pod ID of the host",
+ "name": "podid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the hypervisor version",
+ "name": "hypervisorversion",
+ "type": "string"
+ },
+ {
"description": "the amount of the host's memory currently allocated in bytes",
"name": "memoryallocatedbytes",
"type": "long"
},
{
+ "description": "the host version",
+ "name": "version",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor",
+ "name": "cpuwithoverprovisioning",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the host",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the host's CPU currently allocated in MHz",
+ "name": "cpuallocatedvalue",
+ "type": "long"
+ },
+ {
+ "description": "the CPU speed of the host",
+ "name": "cpuspeed",
+ "type": "long"
+ },
+ {
+ "description": "the total disk size of the host",
+ "name": "disksizetotal",
+ "type": "long"
+ },
+ {
+ "description": "the host HA information information",
+ "name": "hostha",
+ "type": "hostharesponse"
+ },
+ {
+ "description": "Host details in key/value pairs.",
+ "name": "details",
+ "type": "map"
+ },
+ {
+ "description": "the date and time the host was removed",
+ "name": "removed",
+ "type": "date"
+ },
+ {
+ "description": "the amount of the host's CPU currently used",
+ "name": "cpuused",
+ "type": "string"
+ },
+ {
+ "description": "the incoming network traffic on the host",
+ "name": "networkkbsread",
+ "type": "long"
+ },
+ {
+ "description": "the admin that annotated this host",
+ "name": "username",
+ "type": "string"
+ },
+ {
+ "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise",
+ "name": "suitableformigration",
+ "type": "boolean"
+ },
+ {
+ "description": "the OS category ID of the host",
+ "name": "oscategoryid",
+ "type": "string"
+ },
+ {
"description": "the Zone name of the host",
"name": "zonename",
"type": "string"
+ },
+ {
+ "description": "the amount of the host's CPU currently allocated in percentage",
+ "name": "cpuallocatedpercentage",
+ "type": "string"
+ },
+ {
+ "description": "the cluster name of the host",
+ "name": "clustername",
+ "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": "true if the host has capability to support UEFI boot",
+ "name": "ueficapability",
+ "type": "boolean"
+ },
+ {
+ "description": "the last annotation set on this host by an admin",
+ "name": "annotation",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the host's memory currently allocated",
+ "name": "memoryallocated",
+ "type": "long"
+ },
+ {
+ "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise",
+ "name": "hasenoughcapacity",
+ "type": "boolean"
+ },
+ {
+ "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise",
+ "name": "hahost",
+ "type": "boolean"
+ },
+ {
+ "description": "the name of the host",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor",
+ "name": "cpuallocatedwithoverprovisioning",
+ "type": "string"
+ },
+ {
+ "description": "the date and time the host was last pinged",
+ "name": "lastpinged",
+ "type": "date"
+ },
+ {
+ "description": "the amount of the host's memory currently used",
+ "name": "memoryused",
+ "type": "long"
+ },
+ {
+ "description": "the host's currently allocated disk size",
+ "name": "disksizeallocated",
+ "type": "long"
+ },
+ {
+ "description": "the IP address of the host",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "the cpu average load on the host",
+ "name": "cpuloadaverage",
+ "type": "double"
+ },
+ {
+ "description": "the host type",
+ "name": "type",
+ "type": "type"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
}
]
},
@@ -76080,11 +77190,12 @@
"name": "attachVolume",
"params": [
{
- "description": "the ID of the device to map the volume to within the guest OS. If no deviceId is passed in, the next available deviceId will be chosen. Possible values for a Linux OS are:* 0 - /dev/xvda* 1 - /dev/xvdb* 2 - /dev/xvdc* 4 - /dev/xvde* 5 - /dev/xvdf* 6 - /dev/xvdg* 7 - /dev/xvdh* 8 - /dev/xvdi* 9 - /dev/xvdj",
+ "description": " the ID of the virtual machine",
"length": 255,
- "name": "deviceid",
- "required": false,
- "type": "long"
+ "name": "virtualmachineid",
+ "related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance",
+ "required": true,
+ "type": "uuid"
},
{
"description": "the ID of the disk volume",
@@ -76095,142 +77206,40 @@
"type": "uuid"
},
{
- "description": " the ID of the virtual machine",
+ "description": "the ID of the device to map the volume to within the guest OS. If no deviceId is passed in, the next available deviceId will be chosen. Possible values for a Linux OS are:* 0 - /dev/xvda* 1 - /dev/xvdb* 2 - /dev/xvdc* 4 - /dev/xvde* 5 - /dev/xvdf* 6 - /dev/xvdg* 7 - /dev/xvdh* 8 - /dev/xvdi* 9 - /dev/xvdj",
"length": 255,
- "name": "virtualmachineid",
- "related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance",
- "required": true,
- "type": "uuid"
+ "name": "deviceid",
+ "required": false,
+ "type": "long"
}
],
"related": "createVolume,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume",
"response": [
{
- "description": "the name of the template for the virtual machine",
- "name": "templatename",
+ "description": " an alternate display text of the template for the virtual machine",
+ "name": "templatedisplaytext",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the project name of the vpn",
+ "name": "project",
"type": "string"
},
{
- "description": "name of the virtual machine",
- "name": "vmname",
- "type": "string"
- },
- {
- "description": "name of the disk offering",
- "name": "diskofferingname",
- "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": "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 domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "the 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": "shared or local storage",
- "name": "storagetype",
- "type": "string"
- },
- {
- "description": "need quiesce vm or not when taking snapshot",
- "name": "quiescevm",
- "type": "boolean"
- },
- {
- "description": "the display text of the disk offering",
- "name": "diskofferingdisplaytext",
- "type": "string"
- },
- {
- "description": "ID of the availability zone",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the project id of the vpn",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "ID of the service offering for root disk",
- "name": "serviceofferingid",
- "type": "string"
- },
- {
- "description": "cluster id of the volume",
- "name": "clusterid",
- "type": "string"
- },
- {
- "description": "id of the virtual machine",
- "name": "virtualmachineid",
- "type": "string"
- },
- {
- "description": "max iops of the disk volume",
- "name": "maxiops",
+ "description": "the bytes allocated",
+ "name": "physicalsize",
"type": "long"
},
{
- "description": "cluster name where the volume is allocated",
- "name": "clustername",
- "type": "string"
+ "description": "the read (bytes) of disk on the vm",
+ "name": "diskkbsread",
+ "type": "long"
},
{
- "description": "bytes write rate of the disk volume",
- "name": "diskBytesWriteRate",
- "type": "long"
+ "description": "the date the volume was attached to a VM instance",
+ "name": "attached",
+ "type": "date"
},
{
"description": "Hypervisor the volume belongs to",
@@ -76238,33 +77247,18 @@
"type": "string"
},
{
- "description": "min iops of the disk volume",
- "name": "miniops",
- "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 read (io) of disk on the vm",
- "name": "diskioread",
- "type": "long"
- },
- {
- "description": "size of the disk volume",
- "name": "size",
- "type": "long"
- },
- {
- "description": "the name of the ISO attached to the virtual machine",
- "name": "isoname",
+ "description": "the status of the volume",
+ "name": "status",
"type": "string"
},
{
- "description": "pod id of the volume",
- "name": "podid",
+ "description": "the boolean state of whether the volume is destroyed or not",
+ "name": "destroyed",
+ "type": "boolean"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
@@ -76273,143 +77267,16 @@
"type": "long"
},
{
- "description": "the bytes actually consumed on disk",
- "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 account associated with the disk volume",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.",
- "name": "templateid",
- "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": "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": "bytes read rate of the disk volume",
- "name": "diskBytesReadRate",
- "type": "long"
- },
- {
- "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": "ID of the disk offering",
- "name": "diskofferingid",
- "type": "string"
- },
- {
- "description": "an alternate display text of the ISO attached to the virtual machine",
- "name": "isodisplaytext",
- "type": "string"
- },
- {},
- {
- "description": "state of the virtual machine",
- "name": "vmstate",
- "type": "string"
- },
- {},
- {
- "description": "the write (bytes) of disk on the vm",
- "name": "diskkbswrite",
- "type": "long"
- },
- {
- "description": "ID of the snapshot from which this volume was created",
- "name": "snapshotid",
- "type": "string"
- },
- {
- "description": "the project name of the vpn",
- "name": "project",
- "type": "string"
- },
- {
- "description": " an alternate display text of the template for the virtual machine",
- "name": "templatedisplaytext",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "name of the service offering for root disk",
- "name": "serviceofferingname",
- "type": "string"
- },
- {
"description": "the ID of the domain associated with the disk volume",
"name": "domainid",
"type": "string"
},
{
- "description": "the chain info of the volume",
- "name": "chaininfo",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "ID of the disk volume",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the write (io) of disk on the vm",
- "name": "diskiowrite",
+ "description": "size of the disk volume",
+ "name": "size",
"type": "long"
},
{
- "description": "name of the primary storage hosting the disk volume",
- "name": "storage",
- "type": "string"
- },
- {
- "description": "true if storage snapshot is supported for the volume, false otherwise",
- "name": "supportsstoragesnapshot",
- "type": "boolean"
- },
- {
"description": "display name of the virtual machine",
"name": "vmdisplayname",
"type": "string"
@@ -76420,63 +77287,18 @@
"type": "string"
},
{
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "the bytes allocated",
- "name": "physicalsize",
- "type": "long"
- },
- {
- "description": "io requests write rate of the disk volume per the disk offering",
- "name": "diskIopsWriteRate",
- "type": "long"
- },
- {
- "description": "the ID of the ISO attached to the virtual machine",
- "name": "isoid",
+ "description": "cluster name where the volume is allocated",
+ "name": "clustername",
"type": "string"
},
{
- "description": "pod name of the volume",
- "name": "podname",
- "type": "string"
- },
- {
- "description": "provisioning type used to create volumes.",
- "name": "provisioningtype",
- "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": "the read (bytes) of disk on the vm",
- "name": "diskkbsread",
- "type": "long"
- },
- {
"description": "the disk utilization",
"name": "utilization",
"type": "string"
},
{
- "description": "the domain associated with the disk volume",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "type of the disk volume (ROOT or DATADISK)",
- "name": "type",
+ "description": "shared or local storage",
+ "name": "storagetype",
"type": "string"
},
{
@@ -76485,9 +77307,297 @@
"type": "string"
},
{
- "description": "the date the volume was attached to a VM instance",
- "name": "attached",
+ "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",
+ "type": "string"
+ },
+ {
+ "description": "the display text of the service offering for root disk",
+ "name": "serviceofferingdisplaytext",
+ "type": "string"
+ },
+ {
+ "description": "the name of the ISO attached to the virtual machine",
+ "name": "isoname",
+ "type": "string"
+ },
+ {
+ "description": "state of the virtual machine",
+ "name": "vmstate",
+ "type": "string"
+ },
+ {
+ "description": "name of the service offering for root disk",
+ "name": "serviceofferingname",
+ "type": "string"
+ },
+ {
+ "description": "the bytes actually consumed on disk",
+ "name": "virtualsize",
+ "type": "long"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "name of the availability zone",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "the name of the template for the virtual machine",
+ "name": "templatename",
+ "type": "string"
+ },
+ {
+ "description": "ID of the service offering for root disk",
+ "name": "serviceofferingid",
+ "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": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "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",
+ "type": "string"
+ },
+ {
+ "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",
+ "type": "string"
+ },
+ {
+ "description": "ID of the availability zone",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "true if the volume is extractable, false otherwise",
+ "name": "isextractable",
+ "type": "boolean"
+ },
+ {
+ "description": "io requests write rate of the disk volume per the disk offering",
+ "name": "diskIopsWriteRate",
+ "type": "long"
+ },
+ {
+ "description": "pod id of the volume",
+ "name": "podid",
+ "type": "string"
+ },
+ {
+ "description": "the project id of the vpn",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "need quiesce vm or not when taking snapshot",
+ "name": "quiescevm",
+ "type": "boolean"
+ },
+ {
+ "description": "the 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 write (bytes) of disk on the vm",
+ "name": "diskkbswrite",
+ "type": "long"
+ },
+ {
+ "description": "true if storage snapshot is supported for the volume, false otherwise",
+ "name": "supportsstoragesnapshot",
+ "type": "boolean"
+ },
+ {
+ "description": "provisioning type used to create volumes.",
+ "name": "provisioningtype",
+ "type": "string"
+ },
+ {
+ "description": "the chain info of the volume",
+ "name": "chaininfo",
+ "type": "string"
+ },
+ {
+ "description": "an optional field whether to the display the volume to the end user or not.",
+ "name": "displayvolume",
+ "type": "boolean"
+ },
+ {
+ "description": "the read (io) of disk on the vm",
+ "name": "diskioread",
+ "type": "long"
+ },
+ {
+ "description": "id of the virtual machine",
+ "name": "virtualmachineid",
+ "type": "string"
+ },
+ {
+ "description": "name of the disk offering",
+ "name": "diskofferingname",
+ "type": "string"
+ },
+ {
+ "description": "max iops of the disk volume",
+ "name": "maxiops",
+ "type": "long"
+ },
+ {
+ "description": "name of the disk volume",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "cluster id of the volume",
+ "name": "clusterid",
+ "type": "string"
+ },
+ {
+ "description": "type of the disk volume (ROOT or DATADISK)",
+ "name": "type",
+ "type": "string"
+ },
+ {
+ "description": "ID of the disk offering",
+ "name": "diskofferingid",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the disk volume",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "min iops of the disk volume",
+ "name": "miniops",
+ "type": "long"
+ },
+ {
+ "description": "the date the disk volume was created",
+ "name": "created",
"type": "date"
+ },
+ {
+ "description": "the display text of the disk offering",
+ "name": "diskofferingdisplaytext",
+ "type": "string"
+ },
+ {
+ "description": "bytes read rate of the disk volume",
+ "name": "diskBytesReadRate",
+ "type": "long"
+ },
+ {
+ "description": "id of the primary storage hosting the disk volume; returned to admin user only",
+ "name": "storageid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.",
+ "name": "templateid",
+ "type": "string"
+ },
+ {
+ "description": "bytes write rate of the disk volume",
+ "name": "diskBytesWriteRate",
+ "type": "long"
+ },
+ {
+ "description": "pod name of the volume",
+ "name": "podname",
+ "type": "string"
+ },
+ {
+ "description": "the write (io) of disk on the vm",
+ "name": "diskiowrite",
+ "type": "long"
+ },
+ {
+ "description": "the ID of the ISO attached to the virtual machine",
+ "name": "isoid",
+ "type": "string"
+ },
+ {
+ "description": "ID of the disk volume",
+ "name": "id",
+ "type": "string"
}
]
},
@@ -76504,13 +77614,6 @@
"type": "string"
},
{
- "description": "Type of dhcp device",
- "length": 255,
- "name": "dhcpservertype",
- "required": true,
- "type": "string"
- },
- {
"description": "URL of the external dhcp appliance.",
"length": 255,
"name": "url",
@@ -76531,47 +77634,54 @@
"name": "password",
"required": true,
"type": "string"
+ },
+ {
+ "description": "Type of dhcp device",
+ "length": 255,
+ "name": "dhcpservertype",
+ "required": true,
+ "type": "string"
}
],
"related": "listBaremetalDhcp",
"response": [
{
- "description": "name of the provider",
- "name": "dhcpservertype",
- "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": "name of the provider",
"name": "provider",
"type": "string"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
"description": "the physical network to which this external dhcp device belongs to",
"name": "physicalnetworkid",
"type": "string"
},
+ {},
+ {
+ "description": "name of the provider",
+ "name": "dhcpservertype",
+ "type": "string"
+ },
{
"description": "device id of ",
"name": "id",
"type": "string"
},
+ {},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
},
- {}
+ {
+ "description": "url",
+ "name": "url",
+ "type": "string"
+ }
]
},
{
@@ -76580,20 +77690,6 @@
"name": "addTrafficMonitor",
"params": [
{
- "description": "Traffic going into the listed zones will be metered",
- "length": 255,
- "name": "includezones",
- "required": false,
- "type": "string"
- },
- {
- "description": "Traffic going into the listed zones will not be metered",
- "length": 255,
- "name": "excludezones",
- "required": false,
- "type": "string"
- },
- {
"description": "Zone in which to add the external firewall appliance.",
"length": 255,
"name": "zoneid",
@@ -76602,37 +77698,34 @@
"type": "uuid"
},
{
+ "description": "Traffic going into the listed zones will be metered",
+ "length": 255,
+ "name": "includezones",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "URL of the traffic monitor Host",
"length": 255,
"name": "url",
"required": true,
"type": "string"
+ },
+ {
+ "description": "Traffic going into the listed zones will not be metered",
+ "length": 255,
+ "name": "excludezones",
+ "required": false,
+ "type": "string"
}
],
"related": "",
"response": [
{
- "description": "the timeout (in seconds) for requests to the external firewall",
- "name": "timeout",
- "type": "string"
- },
- {},
- {
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
- {},
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the zone ID of the external firewall",
- "name": "zoneid",
- "type": "string"
- },
{
"description": "the ID of the external firewall",
"name": "id",
@@ -76647,7 +77740,24 @@
"description": "the management IP address of the external firewall",
"name": "ipaddress",
"type": "string"
- }
+ },
+ {},
+ {
+ "description": "the timeout (in seconds) for requests to the external firewall",
+ "name": "timeout",
+ "type": "string"
+ },
+ {
+ "description": "the zone ID of the external firewall",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {}
]
},
{
@@ -76656,13 +77766,6 @@
"name": "updateProject",
"params": [
{
- "description": "display text of the project",
- "length": 255,
- "name": "displaytext",
- "required": false,
- "type": "string"
- },
- {
"description": "id of the project to be modified",
"length": 255,
"name": "id",
@@ -76678,13 +77781,6 @@
"type": "string"
},
{
- "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": "ID of the user to be promoted/demoted",
"length": 255,
"name": "userid",
@@ -76698,38 +77794,27 @@
"name": "roletype",
"required": false,
"type": "string"
+ },
+ {
+ "description": "display text of the project",
+ "length": 255,
+ "name": "displaytext",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "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"
}
],
"related": "activateProject,suspendProject",
"response": [
{
- "description": "the total volume being used by this project",
- "name": "volumetotal",
- "type": "long"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the displaytext of the project",
- "name": "displaytext",
- "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 deployed by this project",
- "name": "vmtotal",
- "type": "long"
- },
- {
- "description": "the total number of snapshots which can be stored by this project",
- "name": "snapshotlimit",
+ "description": "the total number of virtual machines that can be deployed by this project",
+ "name": "vmlimit",
"type": "string"
},
{
@@ -76738,90 +77823,53 @@
"type": "string"
},
{
- "description": "the id of the project",
- "name": "id",
- "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",
- "type": "string"
- },
- {
- "description": "the total number of public ip addresses available for this project to acquire",
- "name": "ipavailable",
- "type": "string"
- },
- {
- "description": "the total number of 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 number of vpcs available to be created for this project",
- "name": "vpcavailable",
- "type": "string"
- },
- {
- "description": "the name of the project",
- "name": "name",
- "type": "string"
- },
- {
"description": "the state of the project",
"name": "state",
"type": "string"
},
{
- "description": "the total number of networks the project can own",
- "name": "networklimit",
- "type": "string"
- },
- {},
- {},
- {
- "description": "the total number of snapshots available for this project",
- "name": "snapshotavailable",
+ "description": "the total memory (in MB) available to be created for this project",
+ "name": "memoryavailable",
"type": "string"
},
{
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
- },
- {
- "description": "the total number of vpcs the project can own",
- "name": "vpclimit",
+ "description": "the total number of public ip addresses this project can acquire",
+ "name": "iplimit",
"type": "string"
},
{
- "description": "the total number of virtual machines stopped for this project",
- "name": "vmstopped",
+ "description": "the total number of snapshots which can be stored by this project",
+ "name": "snapshotlimit",
+ "type": "string"
+ },
+ {
+ "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",
"type": "integer"
},
{
- "description": "the total number of public ip addresses allocated for this project",
- "name": "iptotal",
- "type": "long"
- },
- {
- "description": "the project account name of the project",
- "name": "projectaccountname",
+ "description": "the total volume which can be used by this project",
+ "name": "volumelimit",
"type": "string"
},
{
- "description": "the total number of cpu cores available to be created for this project",
- "name": "cpuavailable",
+ "description": "the total primary storage space (in GiB) the project can own",
+ "name": "primarystoragelimit",
+ "type": "string"
+ },
+ {
+ "description": "the date this project was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the domain name where the project belongs to",
+ "name": "domain",
"type": "string"
},
{
@@ -76830,18 +77878,58 @@
"type": "string"
},
{
- "description": "the total memory (in MB) owned by project",
- "name": "memorytotal",
+ "description": "the total number of networks owned by project",
+ "name": "networktotal",
"type": "long"
},
{
- "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 number of vpcs owned by project",
- "name": "vpctotal",
+ "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 primary storage space (in GiB) owned by project",
+ "name": "primarystoragetotal",
+ "type": "long"
+ },
+ {
+ "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 volume being used by this project",
+ "name": "volumetotal",
+ "type": "long"
+ },
+ {
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "description": "the total memory (in MB) the project can own",
+ "name": "memorylimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of virtual machines deployed by this project",
+ "name": "vmtotal",
"type": "long"
},
{
@@ -76850,8 +77938,59 @@
"type": "string"
},
{
- "description": "the total number of templates which can be created by this project",
- "name": "templatelimit",
+ "description": "the domain id the project belongs to",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the total number of networks the project can own",
+ "name": "networklimit",
+ "type": "string"
+ },
+ {
+ "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",
+ "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 account name of the project's owners",
+ "name": "owner",
+ "type": "list"
+ },
+ {
+ "description": "the id of the project",
+ "name": "id",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the total number of public ip addresses available for this project to acquire",
+ "name": "ipavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of public ip addresses allocated for this project",
+ "name": "iptotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of cpu cores the project can own",
+ "name": "cpulimit",
"type": "string"
},
{
@@ -76859,31 +77998,6 @@
"name": "tags",
"response": [
{
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "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"
@@ -76894,51 +78008,56 @@
"type": "string"
},
{
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "the 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 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 total secondary storage space (in GiB) owned by project",
- "name": "secondarystoragetotal",
- "type": "float"
- },
- {
- "description": "the total number of virtual machines available for this project to acquire",
- "name": "vmavailable",
- "type": "string"
- },
- {
"description": "the total number of networks available to be created for this project",
"name": "networkavailable",
"type": "string"
},
{
- "description": "the domain name where the project belongs to",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the total volume available for this project",
- "name": "volumeavailable",
- "type": "string"
- },
- {
- "description": "the total volume which can be used by this project",
- "name": "volumelimit",
+ "description": "the displaytext of the project",
+ "name": "displaytext",
"type": "string"
},
{
@@ -76947,54 +78066,45 @@
"type": "long"
},
{
- "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 total primary storage space (in GiB) owned by project",
- "name": "primarystoragetotal",
+ "description": "the total number of virtual machines stopped for this project",
+ "name": "vmstopped",
+ "type": "integer"
+ },
+ {},
+ {
+ "description": "the total number of vpcs owned by project",
+ "name": "vpctotal",
"type": "long"
},
{
- "description": "the total number of snapshots stored by this project",
- "name": "snapshottotal",
- "type": "long"
- },
- {
- "description": "the date this project was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the total primary storage space (in GiB) the project can own",
- "name": "primarystoragelimit",
- "type": "string"
- },
- {
- "description": "the total number of networks owned by project",
- "name": "networktotal",
- "type": "long"
- },
- {
- "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 project",
+ "name": "vmrunning",
"type": "integer"
},
{
- "description": "the domain id the project belongs to",
- "name": "domainid",
+ "description": "the total memory (in MB) owned by project",
+ "name": "memorytotal",
+ "type": "long"
+ },
+ {
+ "description": "the name of the project",
+ "name": "name",
"type": "string"
},
{
- "description": "the 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 secondary storage space (in GiB) the project can own",
- "name": "secondarystoragelimit",
- "type": "string"
+ "description": "the total secondary storage space (in GiB) owned by project",
+ "name": "secondarystoragetotal",
+ "type": "float"
}
],
"since": "3.0.0"
@@ -77005,25 +78115,11 @@
"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"
- },
- {
- "description": "the name of the load balancer",
- "length": 255,
- "name": "name",
- "required": false,
- "type": "string"
- },
- {
- "description": "",
- "length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
+ "type": "boolean"
},
{
"description": "the scheme of the load balancer. Supported value is internal in the current release",
@@ -77041,6 +78137,13 @@
"type": "uuid"
},
{
+ "description": "list resources by account. Must be used with the domainId parameter.",
+ "length": 255,
+ "name": "account",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "the network ID of the source IP address",
"length": 255,
"name": "sourceipaddressnetworkid",
@@ -77049,39 +78152,9 @@
"type": "uuid"
},
{
- "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
+ "description": "List by keyword",
"length": 255,
- "name": "isrecursive",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter",
- "length": 255,
- "name": "fordisplay",
- "required": false,
- "since": "4.4",
- "type": "boolean"
- },
- {
- "description": "list objects by project",
- "length": 255,
- "name": "projectid",
- "related": "activateProject,suspendProject",
- "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": "the source IP address of the load balancer",
- "length": 255,
- "name": "sourceipaddress",
+ "name": "keyword",
"required": false,
"type": "string"
},
@@ -77093,18 +78166,11 @@
"type": "integer"
},
{
- "description": "List by keyword",
+ "description": "",
"length": 255,
- "name": "keyword",
+ "name": "page",
"required": false,
- "type": "string"
- },
- {
- "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false",
- "length": 255,
- "name": "listall",
- "required": false,
- "type": "boolean"
+ "type": "integer"
},
{
"description": "the ID of the load balancer",
@@ -77115,19 +78181,75 @@
"type": "uuid"
},
{
+ "description": "list objects by project",
+ "length": 255,
+ "name": "projectid",
+ "related": "activateProject,suspendProject",
+ "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",
+ "length": 255,
+ "name": "listall",
+ "required": false,
+ "type": "boolean"
+ },
+ {
"description": "list only resources belonging to the domain specified",
"length": 255,
"name": "domainid",
"related": "listDomainChildren,listDomains",
"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": "the source IP address of the load balancer",
+ "length": 255,
+ "name": "sourceipaddress",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "List resources by tags (key/value pairs)",
+ "length": 255,
+ "name": "tags",
+ "required": false,
+ "type": "map"
+ },
+ {
+ "description": "the name of the load balancer",
+ "length": 255,
+ "name": "name",
+ "required": false,
+ "type": "string"
}
],
"related": "createLoadBalancer",
"response": [
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the account of the Load Balancer",
+ "name": "account",
+ "type": "string"
+ },
+ {},
+ {},
+ {
+ "description": "Load Balancer source ip network id",
+ "name": "sourceipaddressnetworkid",
+ "type": "string"
+ },
+ {
+ "description": "the load balancer algorithm (source, roundrobin, leastconn)",
+ "name": "algorithm",
"type": "string"
},
{
@@ -77145,32 +78267,21 @@
"type": "string"
},
{
- "description": "the state of the instance",
- "name": "state",
+ "description": "the ip address of the instance",
+ "name": "ipaddress",
"type": "string"
},
{
- "description": "the ip address of the instance",
- "name": "ipaddress",
+ "description": "the state of the instance",
+ "name": "state",
"type": "string"
}
],
"type": "list"
},
{
- "description": "Load Balancer source ip",
- "name": "sourceipaddress",
- "type": "string"
- },
- {},
- {
- "description": "the load balancer algorithm (source, roundrobin, leastconn)",
- "name": "algorithm",
- "type": "string"
- },
- {
- "description": "the project name of the Load Balancer",
- "name": "project",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
@@ -77179,53 +78290,17 @@
"type": "string"
},
{
- "description": "the account of the Load Balancer",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {},
- {
- "description": "the domain of the Load Balancer",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "Load Balancer network id",
- "name": "networkid",
- "type": "string"
+ "description": "is rule for display to the regular user",
+ "name": "fordisplay",
+ "type": "boolean"
},
{
"description": "the list of resource tags associated with the Load Balancer",
"name": "tags",
"response": [
{
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
+ "description": "id of the resource",
+ "name": "resourceid",
"type": "string"
},
{
@@ -77234,8 +78309,18 @@
"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",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
"type": "string"
},
{
@@ -77244,28 +78329,78 @@
"type": "string"
},
{
- "description": "the project name where tag belongs to",
- "name": "project",
+ "description": "customer associated with the tag",
+ "name": "customer",
"type": "string"
},
{
- "description": "the domain associated with the tag",
- "name": "domain",
+ "description": "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"
}
],
"type": "list"
},
{
+ "description": "Load Balancer network id",
+ "name": "networkid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the Load Balancer",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the Load Balancer",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "Load Balancer source ip",
+ "name": "sourceipaddress",
+ "type": "string"
+ },
+ {
+ "description": "the Load Balancer ID",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the project id of the Load Balancer",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the domain of the Load Balancer",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the description of the Load Balancer",
+ "name": "description",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
"description": "the 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"
@@ -77274,39 +78409,14 @@
"description": "source port of the load balancer rule",
"name": "sourceport",
"type": "integer"
+ },
+ {
+ "description": "instance port of the load balancer rule",
+ "name": "instanceport",
+ "type": "integer"
}
],
"type": "list"
- },
- {
- "description": "the name of the Load Balancer",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the description of the Load Balancer",
- "name": "description",
- "type": "string"
- },
- {
- "description": "the project id of the Load Balancer",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the Load Balancer ID",
- "name": "id",
- "type": "string"
- },
- {
- "description": "Load Balancer source ip network id",
- "name": "sourceipaddressnetworkid",
- "type": "string"
- },
- {
- "description": "is rule for display to the regular user",
- "name": "fordisplay",
- "type": "boolean"
}
],
"since": "4.2.0"
@@ -77317,6 +78427,20 @@
"name": "listUsers",
"params": [
{
+ "description": "List user by the username",
+ "length": 255,
+ "name": "username",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "List users by state of the user account.",
+ "length": 255,
+ "name": "state",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
"length": 255,
"name": "isrecursive",
@@ -77324,6 +78448,28 @@
"type": "boolean"
},
{
+ "description": "List user by ID.",
+ "length": 255,
+ "name": "id",
+ "related": "createUser,disableUser,enableUser,getUser,listUsers",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "flag to display the resource icon for users",
+ "length": 255,
+ "name": "showicon",
+ "required": false,
+ "type": "boolean"
+ },
+ {
"description": "List users by account type. Valid types include admin, domain-admin, read-only-admin, or user.",
"length": 255,
"name": "accounttype",
@@ -77331,36 +78477,6 @@
"type": "long"
},
{
- "description": "List user by ID.",
- "length": 255,
- "name": "id",
- "related": "createUser,disableUser,enableUser,getUser,listUsers",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "list only resources belonging to the domain specified",
- "length": 255,
- "name": "domainid",
- "related": "listDomainChildren,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",
- "length": 255,
- "name": "listall",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
- },
- {
"description": "",
"length": 255,
"name": "page",
@@ -77368,16 +78484,9 @@
"type": "integer"
},
{
- "description": "",
+ "description": "List by keyword",
"length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
- },
- {
- "description": "List users by state of the user account.",
- "length": 255,
- "name": "state",
+ "name": "keyword",
"required": false,
"type": "string"
},
@@ -77389,54 +78498,39 @@
"type": "string"
},
{
- "description": "flag to display the resource icon for users",
+ "description": "If set to false, list only 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": "List user by the username",
+ "description": "list only resources belonging to the domain specified",
"length": 255,
- "name": "username",
+ "name": "domainid",
+ "related": "listDomainChildren,listDomains",
"required": false,
- "type": "string"
+ "type": "uuid"
}
],
"related": "createUser,disableUser,enableUser,getUser",
"response": [
{
- "description": "the domain name of the user",
- "name": "domain",
+ "description": "the user lastname",
+ "name": "lastname",
"type": "string"
},
{
- "description": "the source type of the user in lowercase, such as native, ldap, saml2",
- "name": "usersource",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
- "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 ID of the role",
- "name": "roleid",
- "type": "string"
- },
- {
- "description": "the account name of the user",
- "name": "account",
- "type": "string"
- },
- {
"description": "the user state",
"name": "state",
"type": "string"
@@ -77447,56 +78541,11 @@
"type": "string"
},
{
- "description": "the name of the role",
- "name": "rolename",
- "type": "string"
- },
- {
- "description": "the api key of the user",
- "name": "apikey",
- "type": "string"
- },
- {
"description": "the account type of the user",
"name": "accounttype",
"type": "short"
},
{
- "description": "the user firstname",
- "name": "firstname",
- "type": "string"
- },
- {
- "description": "the user email address",
- "name": "email",
- "type": "string"
- },
- {
- "description": "the user name",
- "name": "username",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the user lastname",
- "name": "lastname",
- "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 current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
@@ -77506,10 +78555,56 @@
"name": "timezone",
"type": "string"
},
+ {
+ "description": "the user name",
+ "name": "username",
+ "type": "string"
+ },
+ {
+ "description": "the account ID of the user",
+ "name": "accountid",
+ "type": "string"
+ },
+ {
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
{},
{
- "description": "the user ID",
- "name": "id",
+ "description": "the source type of the user in lowercase, such as native, ldap, saml2",
+ "name": "usersource",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the role",
+ "name": "roleid",
+ "type": "string"
+ },
+ {
+ "description": "the type of the role",
+ "name": "roletype",
+ "type": "string"
+ },
+ {
+ "description": "the domain name of the user",
+ "name": "domain",
+ "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 user firstname",
+ "name": "firstname",
"type": "string"
},
{
@@ -77518,13 +78613,28 @@
"type": "boolean"
},
{
- "description": "the account ID of the user",
- "name": "accountid",
+ "description": "true if user is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {
+ "description": "the user ID",
+ "name": "id",
"type": "string"
},
{
- "description": "the type of the role",
- "name": "roletype",
+ "description": "the user email address",
+ "name": "email",
+ "type": "string"
+ },
+ {
+ "description": "the name of the role",
+ "name": "rolename",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID of the user",
+ "name": "domainid",
"type": "string"
}
]
@@ -77550,23 +78660,23 @@
"name": "secretkey",
"type": "string"
},
+ {},
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {},
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
"description": "the api key of the registered user",
"name": "apikey",
"type": "string"
- },
- {},
- {}
+ }
]
},
{
@@ -77584,6 +78694,7 @@
}
],
"response": [
+ {},
{
"description": "true if operation is executed successfully",
"name": "success",
@@ -77595,7 +78706,6 @@
"type": "string"
},
{},
- {},
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
@@ -77615,6 +78725,27 @@
"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 CIDR of IPv6 network, must be at least /64",
+ "length": 255,
+ "name": "ip6cidr",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "the beginning IP address in the VLAN IP range",
"length": 255,
"name": "startip",
@@ -77622,11 +78753,18 @@
"type": "string"
},
{
- "description": "true if IP range is set to system vms, false if not",
+ "description": "the gateway of the VLAN IP range",
"length": 255,
- "name": "forsystemvms",
+ "name": "gateway",
"required": false,
- "type": "boolean"
+ "type": "string"
+ },
+ {
+ "description": "the ending IPv6 address in the IPv6 network range",
+ "length": 255,
+ "name": "endipv6",
+ "required": false,
+ "type": "string"
},
{
"description": "the netmask of the VLAN IP range",
@@ -77644,13 +78782,6 @@
"type": "uuid"
},
{
- "description": "the CIDR of IPv6 network, must be at least /64",
- "length": 255,
- "name": "ip6cidr",
- "required": false,
- "type": "string"
- },
- {
"description": "the beginning IPv6 address in the IPv6 network range",
"length": 255,
"name": "startipv6",
@@ -77658,55 +78789,18 @@
"type": "string"
},
{
- "description": "the gateway of the IPv6 network",
+ "description": "true if IP range is set to system vms, false if not",
"length": 255,
- "name": "ip6gateway",
+ "name": "forsystemvms",
"required": false,
- "type": "string"
- },
- {
- "description": "the gateway of the VLAN IP range",
- "length": 255,
- "name": "gateway",
- "required": false,
- "type": "string"
- },
- {
- "description": "the ending IP address in the VLAN IP range",
- "length": 255,
- "name": "endip",
- "required": false,
- "type": "string"
- },
- {
- "description": "the ending IPv6 address in the IPv6 network range",
- "length": 255,
- "name": "endipv6",
- "required": false,
- "type": "string"
+ "type": "boolean"
}
],
"related": "dedicatePublicIpRange",
"response": [
- {},
{
- "description": "indicates whether VLAN IP range is dedicated to system vms or not",
- "name": "forsystemvms",
- "type": "boolean"
- },
- {
- "description": "the domain name of the VLAN IP range",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the ID or VID of the VLAN.",
- "name": "vlan",
- "type": "string"
- },
- {
- "description": "the Pod name for the VLAN IP range",
- "name": "podname",
+ "description": "the ID of the VLAN IP range",
+ "name": "id",
"type": "string"
},
{
@@ -77715,74 +78809,13 @@
"type": "string"
},
{
- "description": "the ID of the VLAN IP range",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the Pod ID for the VLAN IP range",
- "name": "podid",
- "type": "string"
- },
- {
- "description": "the start ip of the VLAN IP range",
- "name": "startip",
- "type": "string"
- },
- {
- "description": "the gateway of the VLAN IP range",
- "name": "gateway",
- "type": "string"
- },
- {
- "description": "the start ipv6 of the VLAN IP range",
- "name": "startipv6",
- "type": "string"
- },
- {
"description": "the project id of the vlan range",
"name": "projectid",
"type": "string"
},
{
- "description": "the end ipv6 of the VLAN IP range",
- "name": "endipv6",
- "type": "string"
- },
- {
- "description": "the gateway of IPv6 network",
- "name": "ip6gateway",
- "type": "string"
- },
- {},
- {
- "description": "the network id of vlan range",
- "name": "networkid",
- "type": "string"
- },
- {
- "description": "the account of the VLAN IP range",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the project name of the vlan range",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the virtual network for the VLAN IP range",
- "name": "forvirtualnetwork",
- "type": "boolean"
- },
- {
- "description": "the domain ID of the VLAN IP range",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the cidr of IPv6 network",
- "name": "ip6cidr",
+ "description": "the Pod name for the VLAN IP range",
+ "name": "podname",
"type": "string"
},
{
@@ -77791,18 +78824,64 @@
"type": "string"
},
{
+ "description": "the domain ID of the VLAN IP range",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the account of the VLAN IP range",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the gateway of the VLAN IP range",
+ "name": "gateway",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the domain name of the VLAN IP range",
+ "name": "domain",
+ "type": "string"
+ },
+ {
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
{
+ "description": "the Pod ID for the VLAN IP range",
+ "name": "podid",
+ "type": "string"
+ },
+ {
+ "description": "the virtual network for the VLAN IP range",
+ "name": "forvirtualnetwork",
+ "type": "boolean"
+ },
+ {
+ "description": "the end ipv6 of the VLAN IP range",
+ "name": "endipv6",
+ "type": "string"
+ },
+ {
"description": "the description of the VLAN IP range",
"name": "description",
"type": "string"
},
{
- "description": "the Zone ID of the VLAN IP range",
- "name": "zoneid",
+ "description": "indicates whether VLAN IP range is dedicated to system vms or not",
+ "name": "forsystemvms",
+ "type": "boolean"
+ },
+ {
+ "description": "the network id of vlan range",
+ "name": "networkid",
+ "type": "string"
+ },
+ {
+ "description": "the start ipv6 of the VLAN IP range",
+ "name": "startipv6",
"type": "string"
},
{
@@ -77811,6 +78890,37 @@
"type": "string"
},
{
+ "description": "the project name of the vlan range",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the ID or VID of the VLAN.",
+ "name": "vlan",
+ "type": "string"
+ },
+ {
+ "description": "the start ip of the VLAN IP range",
+ "name": "startip",
+ "type": "string"
+ },
+ {
+ "description": "the gateway of IPv6 network",
+ "name": "ip6gateway",
+ "type": "string"
+ },
+ {
+ "description": "the Zone ID of the VLAN IP range",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the cidr of IPv6 network",
+ "name": "ip6cidr",
+ "type": "string"
+ },
+ {
"description": "the end ip of the VLAN IP range",
"name": "endip",
"type": "string"
@@ -77824,11 +78934,24 @@
"name": "listVpnConnections",
"params": [
{
- "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter",
+ "description": "List by keyword",
"length": 255,
- "name": "fordisplay",
+ "name": "keyword",
"required": false,
- "since": "4.4",
+ "type": "string"
+ },
+ {
+ "description": "list resources by account. Must be used with the domainId parameter.",
+ "length": 255,
+ "name": "account",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
+ "length": 255,
+ "name": "isrecursive",
+ "required": false,
"type": "boolean"
},
{
@@ -77840,6 +78963,21 @@
"type": "uuid"
},
{
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "list objects by project",
+ "length": 255,
+ "name": "projectid",
+ "related": "activateProject,suspendProject",
+ "required": false,
+ "type": "uuid"
+ },
+ {
"description": "id of vpc",
"length": 255,
"name": "vpcid",
@@ -77848,13 +78986,6 @@
"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",
"length": 255,
"name": "domainid",
@@ -77870,35 +79001,14 @@
"type": "integer"
},
{
- "description": "",
+ "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter",
"length": 255,
- "name": "pagesize",
+ "name": "fordisplay",
"required": false,
- "type": "integer"
- },
- {
- "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
- "length": 255,
- "name": "isrecursive",
- "required": false,
+ "since": "4.4",
"type": "boolean"
},
{
- "description": "list objects by project",
- "length": 255,
- "name": "projectid",
- "related": "activateProject,suspendProject",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
- },
- {
"description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false",
"length": 255,
"name": "listall",
@@ -77909,38 +79019,13 @@
"related": "createVpnConnection",
"response": [
{
- "description": "the public IP address",
- "name": "publicip",
+ "description": "the customer gateway ID",
+ "name": "s2scustomergatewayid",
"type": "string"
},
{
- "description": "the date and time the host was removed",
- "name": "removed",
- "type": "date"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "State of vpn connection",
- "name": "state",
- "type": "string"
- },
- {
- "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 domain name of the owner",
- "name": "domain",
+ "description": "the project id",
+ "name": "projectid",
"type": "string"
},
{
@@ -77949,31 +79034,36 @@
"type": "string"
},
{
- "description": "if DPD is enabled for customer gateway",
- "name": "dpd",
+ "description": "is connection for display to the regular user",
+ "name": "fordisplay",
"type": "boolean"
},
{
+ "description": "if Force NAT Encapsulation is enabled for customer gateway",
+ "name": "forceencap",
+ "type": "boolean"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "Lifetime of ESP SA of customer gateway",
+ "name": "esplifetime",
+ "type": "long"
+ },
+ {},
+ {
+ "description": "the date and time the host was removed",
+ "name": "removed",
+ "type": "date"
+ },
+ {
"description": "public ip address id of the customer gateway",
"name": "gateway",
"type": "string"
},
- {
- "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).",
- "name": "cidrlist",
- "type": "string"
- },
- {
- "description": "State of vpn connection",
- "name": "passive",
- "type": "boolean"
- },
- {},
- {
- "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike",
- "name": "ikeversion",
- "type": "string"
- },
{},
{
"description": "IPsec Preshared-Key of the customer gateway",
@@ -77981,33 +79071,58 @@
"type": "string"
},
{
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the date and time the host was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).",
+ "name": "cidrlist",
+ "type": "string"
+ },
+ {
+ "description": "if DPD is enabled for customer gateway",
+ "name": "dpd",
+ "type": "boolean"
+ },
+ {
+ "description": "the domain id of the owner",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
"description": "ESP policy of the customer gateway",
"name": "esppolicy",
"type": "string"
},
{
+ "description": "the domain name of the owner",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the owner",
+ "name": "account",
+ "type": "string"
+ },
+ {
"description": "the vpn gateway ID",
"name": "s2svpngatewayid",
"type": "string"
},
{
- "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"
- },
- {
- "description": "the owner",
- "name": "account",
+ "description": "the connection ID",
+ "name": "id",
"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"
},
{
@@ -78016,34 +79131,29 @@
"type": "string"
},
{
- "description": "the project id",
- "name": "projectid",
+ "description": "the public IP address",
+ "name": "publicip",
"type": "string"
},
{
- "description": "the connection ID",
- "name": "id",
- "type": "string"
- },
- {
- "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": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.",
+ "name": "splitconnections",
+ "type": "boolean"
+ },
+ {
+ "description": "State of vpn connection",
+ "name": "state",
+ "type": "string"
+ },
+ {
"description": "Lifetime of IKE SA of customer gateway",
"name": "ikelifetime",
"type": "long"
- },
- {
- "description": "the date and time the host was created",
- "name": "created",
- "type": "date"
}
]
},
@@ -78053,25 +79163,12 @@
"name": "listResourceLimits",
"params": [
{
- "description": "",
+ "description": "list only resources belonging to the domain specified",
"length": 255,
- "name": "page",
+ "name": "domainid",
+ "related": "listDomainChildren,listDomains",
"required": false,
- "type": "integer"
- },
- {
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
- },
- {
- "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false",
- "length": 255,
- "name": "listall",
- "required": false,
- "type": "boolean"
+ "type": "uuid"
},
{
"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. ",
@@ -78088,6 +79185,13 @@
"type": "boolean"
},
{
+ "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false",
+ "length": 255,
+ "name": "listall",
+ "required": false,
+ "type": "boolean"
+ },
+ {
"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": "resourcetype",
@@ -78095,6 +79199,28 @@
"type": "integer"
},
{
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "list objects by project",
+ "length": 255,
+ "name": "projectid",
+ "related": "activateProject,suspendProject",
+ "required": false,
+ "type": "uuid"
+ },
+ {
"description": "list resources by account. Must be used with the domainId parameter.",
"length": 255,
"name": "account",
@@ -78102,13 +79228,6 @@
"type": "string"
},
{
- "description": "Lists resource limits by ID.",
- "length": 255,
- "name": "id",
- "required": false,
- "type": "long"
- },
- {
"description": "",
"length": 255,
"name": "pagesize",
@@ -78116,38 +79235,23 @@
"type": "integer"
},
{
- "description": "list only resources belonging to the domain specified",
+ "description": "Lists resource limits by ID.",
"length": 255,
- "name": "domainid",
- "related": "listDomainChildren,listDomains",
+ "name": "id",
"required": false,
- "type": "uuid"
- },
- {
- "description": "list objects by project",
- "length": 255,
- "name": "projectid",
- "related": "activateProject,suspendProject",
- "required": false,
- "type": "uuid"
+ "type": "long"
}
],
"related": "",
"response": [
{
- "description": "the project name of the resource limit",
- "name": "project",
- "type": "string"
- },
- {},
- {
- "description": "the account of the resource limit",
- "name": "account",
+ "description": "the domain name of the resource limit",
+ "name": "domain",
"type": "string"
},
{
- "description": "resource type name. Values include user_vm, public_ip, volume, snapshot, template, project, network, vpc, cpu, memory, primary_storage, secondary_storage.",
- "name": "resourcetypename",
+ "description": "the project id of the resource limit",
+ "name": "projectid",
"type": "string"
},
{
@@ -78156,9 +79260,14 @@
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "resource type name. Values include user_vm, public_ip, volume, snapshot, template, project, network, vpc, cpu, memory, primary_storage, secondary_storage.",
+ "name": "resourcetypename",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the resource limit",
+ "name": "project",
+ "type": "string"
},
{
"description": "the maximum number of the resource. A -1 means the resource currently has no limit.",
@@ -78171,20 +79280,21 @@
"type": "string"
},
{},
- {
- "description": "the project id of the resource limit",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the domain name of the resource limit",
- "name": "domain",
- "type": "string"
- },
+ {},
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the account of the resource limit",
+ "name": "account",
+ "type": "string"
}
]
},
@@ -78205,8 +79315,13 @@
"related": "createUser,enableUser,getUser",
"response": [
{
- "description": "the timezone user was created in",
- "name": "timezone",
+ "description": "true if user is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {
+ "description": "the api key of the user",
+ "name": "apikey",
"type": "string"
},
{
@@ -78215,28 +79330,19 @@
"type": "string"
},
{
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
- },
- {
- "description": "the account name of the user",
- "name": "account",
+ "description": "the user lastname",
+ "name": "lastname",
"type": "string"
},
{
- "description": "the account ID of the user",
- "name": "accountid",
+ "description": "the user name",
+ "name": "username",
"type": "string"
},
+ {},
{
- "description": "the source type of the user in lowercase, such as native, ldap, saml2",
- "name": "usersource",
- "type": "string"
- },
- {
- "description": "the user email address",
- "name": "email",
+ "description": "the user firstname",
+ "name": "firstname",
"type": "string"
},
{
@@ -78245,75 +79351,13 @@
"type": "string"
},
{
- "description": "the boolean value representing if the updating target is in caller's child domain",
- "name": "iscallerchilddomain",
- "type": "boolean"
- },
- {},
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the user state",
- "name": "state",
+ "description": "the timezone user was created in",
+ "name": "timezone",
"type": "string"
},
{
- "description": "true if user is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the name of the role",
- "name": "rolename",
- "type": "string"
- },
- {
- "description": "the domain name of the user",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the account type of the user",
- "name": "accounttype",
- "type": "short"
- },
- {},
- {
- "description": "the user name",
- "name": "username",
- "type": "string"
- },
- {
- "description": "the type of the role",
- "name": "roletype",
- "type": "string"
- },
- {
- "description": "the user firstname",
- "name": "firstname",
- "type": "string"
- },
- {
- "description": "the domain ID of the user",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the user lastname",
- "name": "lastname",
- "type": "string"
- },
- {
- "description": "the api key of the user",
- "name": "apikey",
+ "description": "the ID of the role",
+ "name": "roleid",
"type": "string"
},
{
@@ -78322,8 +79366,74 @@
"type": "date"
},
{
- "description": "the ID of the role",
- "name": "roleid",
+ "description": "the domain name of the user",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the user email address",
+ "name": "email",
+ "type": "string"
+ },
+ {
+ "description": "the account type of the user",
+ "name": "accounttype",
+ "type": "short"
+ },
+ {
+ "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 domain ID of the user",
+ "name": "domainid",
+ "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 user state",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "the source type of the user in lowercase, such as native, ldap, saml2",
+ "name": "usersource",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the name of the role",
+ "name": "rolename",
"type": "string"
}
]
@@ -78334,6 +79444,13 @@
"name": "listIsos",
"params": [
{
+ "description": "true if the ISO is publicly available to all users, false otherwise.",
+ "length": 255,
+ "name": "ispublic",
+ "required": false,
+ "type": "boolean"
+ },
+ {
"description": "true if the ISO is bootable, false otherwise",
"length": 255,
"name": "bootable",
@@ -78341,14 +79458,57 @@
"type": "boolean"
},
{
- "description": "list objects by project",
+ "description": "List by keyword",
"length": 255,
- "name": "projectid",
- "related": "activateProject,suspendProject",
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "list all ISOs by name",
+ "length": 255,
+ "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",
+ "length": 255,
+ "name": "listall",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "list ISO by ID",
+ "length": 255,
+ "name": "id",
+ "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos",
"required": false,
"type": "uuid"
},
{
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "If set to true, list only unique isos across zones",
+ "length": 255,
+ "name": "showunique",
+ "required": false,
+ "since": "4.13.2",
+ "type": "boolean"
+ },
+ {
"description": "list resources by account. Must be used with the domainId parameter.",
"length": 255,
"name": "account",
@@ -78364,18 +79524,12 @@
"type": "uuid"
},
{
- "description": "list all ISOs by name",
+ "description": "the ID of the zone",
"length": 255,
- "name": "name",
+ "name": "zoneid",
+ "related": "createZone,listZones,listZones",
"required": false,
- "type": "string"
- },
- {
- "description": "show removed ISOs as well",
- "length": 255,
- "name": "showremoved",
- "required": false,
- "type": "boolean"
+ "type": "uuid"
},
{
"description": "the hypervisor for which to restrict the search",
@@ -78385,50 +79539,14 @@
"type": "string"
},
{
- "description": "true if this ISO is ready to be deployed",
+ "description": "list objects by project",
"length": 255,
- "name": "isready",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "",
- "length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
- },
- {
- "description": "true if the ISO is publicly available to all users, false otherwise.",
- "length": 255,
- "name": "ispublic",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "the ID of the zone",
- "length": 255,
- "name": "zoneid",
- "related": "createZone,listZones,listZones",
+ "name": "projectid",
+ "related": "activateProject,suspendProject",
"required": false,
"type": "uuid"
},
{
- "description": "If set to true, list only unique isos across zones",
- "length": 255,
- "name": "showunique",
- "required": false,
- "since": "4.13.2",
- "type": "boolean"
- },
- {
- "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false",
- "length": 255,
- "name": "listall",
- "required": false,
- "type": "boolean"
- },
- {
"description": "possible values are \"featured\", \"self\", \"selfexecutable\",\"sharedexecutable\",\"executable\", and \"community\". * featured : templates that have been marked as featured and public. * self : templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns templates that can be used to deploy a new VM. * sharedexecutable : templates ready to be deployed that have been granted to the calling user by another user. * executable : templates that are owned by the calling user, or public templates, that can be used to deploy a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins).",
"length": 255,
"name": "isofilter",
@@ -78436,13 +79554,6 @@
"type": "string"
},
{
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
- },
- {
"description": "flag to display the resource image for the isos",
"length": 255,
"name": "showicon",
@@ -78450,19 +79561,11 @@
"type": "boolean"
},
{
- "description": "list ISO by ID",
+ "description": "true if this ISO is ready to be deployed",
"length": 255,
- "name": "id",
- "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos",
+ "name": "isready",
"required": false,
- "type": "uuid"
- },
- {
- "description": "List resources by tags (key/value pairs)",
- "length": 255,
- "name": "tags",
- "required": false,
- "type": "map"
+ "type": "boolean"
},
{
"description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
@@ -78472,170 +79575,115 @@
"type": "boolean"
},
{
- "description": "",
+ "description": "show removed ISOs as well",
"length": 255,
- "name": "page",
+ "name": "showremoved",
"required": false,
- "type": "integer"
+ "type": "boolean"
+ },
+ {
+ "description": "List resources by tags (key/value pairs)",
+ "length": 255,
+ "name": "tags",
+ "required": false,
+ "type": "map"
}
],
"related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos",
"response": [
{
+ "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": "if Datadisk template, then id of the root disk template this template belongs to",
- "name": "parenttemplateid",
- "type": "string"
- },
- {
- "description": "true if the template is ready to be deployed from, false otherwise.",
- "name": "isready",
- "type": "boolean"
- },
- {
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "if root disk template, then ids of the datas disk templates this template owns",
- "name": "childtemplates",
- "type": "set"
- },
- {
- "description": "additional key/value details tied with template",
- "name": "details",
- "type": "map"
- },
- {},
- {
- "description": "the ID of the secondary storage host for the template",
- "name": "hostid",
- "type": "string"
- },
- {
- "description": "the date this template was removed",
- "name": "removed",
- "type": "date"
- },
- {
- "description": "the physical size of the template",
- "name": "physicalsize",
- "type": "long"
- },
- {
- "description": "the account id to which the template belongs",
- "name": "accountid",
- "type": "string"
- },
- {
- "description": "true if the reset password feature is enabled, false otherwise",
- "name": "passwordenabled",
- "type": "boolean"
- },
- {
- "description": "checksum of the template",
- "name": "checksum",
- "type": "string"
- },
- {
- "description": "the ID of the OS type for this template.",
- "name": "ostypeid",
- "type": "string"
- },
- {
- "description": "the project id of the template",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the account name to which the template belongs",
- "name": "account",
- "type": "string"
- },
- {
- "description": "true if the template is extractable, false otherwise",
- "name": "isextractable",
- "type": "boolean"
- },
- {
- "description": "the status of the template",
- "name": "status",
- "type": "string"
- },
- {
- "description": "Lists the download progress of a template across all secondary storages",
- "name": "downloaddetails",
- "type": "list"
- },
- {
- "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.",
- "name": "deployasis",
- "type": "boolean"
- },
- {
- "description": "the date this template was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the 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 the ISO is bootable, false otherwise",
- "name": "bootable",
- "type": "boolean"
- },
- {
"description": "the project name of the template",
"name": "project",
"type": "string"
},
- {},
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "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",
- "type": "string"
- },
{
"description": "the template ID",
"name": "id",
"type": "string"
},
{
- "description": "the name of the zone for this template",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory",
- "name": "isdynamicallyscalable",
+ "description": "true if this template is a featured template, false otherwise",
+ "name": "isfeatured",
"type": "boolean"
},
{
- "description": "true if template is sshkey enabled, false otherwise",
- "name": "sshkeyenabled",
+ "description": "the date this template was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "true if the ISO is bootable, false otherwise",
+ "name": "bootable",
+ "type": "boolean"
+ },
+ {
+ "description": "the type of the template",
+ "name": "templatetype",
+ "type": "string"
+ },
+ {
+ "description": "the account id to which the template belongs",
+ "name": "accountid",
+ "type": "string"
+ },
+ {
+ "description": "the size of the template",
+ "name": "size",
+ "type": "long"
+ },
+ {
+ "description": "the tag of this template",
+ "name": "templatetag",
+ "type": "string"
+ },
+ {
+ "description": "if Datadisk template, then id of the root disk template this template belongs to",
+ "name": "parenttemplateid",
+ "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": "true if this template is a public template, false otherwise",
+ "name": "ispublic",
+ "type": "boolean"
+ },
+ {
+ "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.",
+ "name": "deployasis",
+ "type": "boolean"
+ },
+ {
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "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"
},
{
@@ -78644,17 +79692,73 @@
"type": "map"
},
{
+ "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": "the physical size of the template",
+ "name": "physicalsize",
+ "type": "long"
+ },
+ {
+ "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": "additional key/value details tied with template",
+ "name": "details",
+ "type": "map"
+ },
+ {
+ "description": "if root disk template, then ids of the datas disk templates this template owns",
+ "name": "childtemplates",
+ "type": "set"
+ },
+ {
+ "description": "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 project id of the template",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the status of the template",
+ "name": "status",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "checksum of the template",
+ "name": "checksum",
+ "type": "string"
+ },
+ {
"description": "the list of resource tags associated",
"name": "tags",
"response": [
{
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
+ "description": "the domain associated with the tag",
+ "name": "domain",
"type": "string"
},
{
@@ -78663,11 +79767,6 @@
"type": "string"
},
{
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
"description": "resource type",
"name": "resourcetype",
"type": "string"
@@ -78683,13 +79782,23 @@
"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": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
"type": "string"
},
{
@@ -78701,14 +79810,49 @@
"type": "set"
},
{
- "description": "the format of the template.",
- "name": "format",
- "type": "imageformat"
+ "description": "the name of the OS type for this template.",
+ "name": "ostypename",
+ "type": "string"
},
{
- "description": "the size of the template",
- "name": "size",
- "type": "long"
+ "description": "the URL which the template/iso is registered from",
+ "name": "url",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the OS type for this template.",
+ "name": "ostypeid",
+ "type": "string"
+ },
+ {
+ "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory",
+ "name": "isdynamicallyscalable",
+ "type": "boolean"
+ },
+ {
+ "description": "the template ID of the parent template if present",
+ "name": "sourcetemplateid",
+ "type": "string"
+ },
+ {
+ "description": "Lists the download progress of a template across all secondary storages",
+ "name": "downloaddetails",
+ "type": "list"
+ },
+ {
+ "description": "true if the template is extractable, false otherwise",
+ "name": "isextractable",
+ "type": "boolean"
+ },
+ {
+ "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage",
+ "name": "directdownload",
+ "type": "boolean"
+ },
+ {
+ "description": "the account name to which the template belongs",
+ "name": "account",
+ "type": "string"
},
{
"description": "the template name",
@@ -78726,48 +79870,18 @@
"type": "boolean"
},
{
- "description": "the tag of this template",
- "name": "templatetag",
+ "description": "the ID of the secondary storage host for the template",
+ "name": "hostid",
"type": "string"
},
{
- "description": "true if this template is a featured template, false otherwise",
- "name": "isfeatured",
- "type": "boolean"
- },
- {
- "description": "the template display text",
- "name": "displaytext",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
- },
- {
- "description": "the ID of 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": "true if this template is a public template, false otherwise",
- "name": "ispublic",
- "type": "boolean"
- },
- {
- "description": "the type of the template",
- "name": "templatetype",
+ "description": "the name of the zone for this template",
+ "name": "zonename",
"type": "string"
},
{
@@ -78775,15 +79889,11 @@
"name": "hypervisor",
"type": "string"
},
+ {},
{
- "description": "the URL which the template/iso is registered from",
- "name": "url",
- "type": "string"
- },
- {
- "description": "the processor bit size",
- "name": "bits",
- "type": "int"
+ "description": "the date this template was removed",
+ "name": "removed",
+ "type": "date"
}
]
},
@@ -78807,23 +79917,64 @@
"type": "string"
},
{
- "description": "the details for the image store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss",
- "length": 255,
- "name": "details",
- "required": false,
- "type": "map"
- },
- {
"description": "the name for the image store",
"length": 255,
"name": "name",
"required": false,
"type": "string"
+ },
+ {
+ "description": "the details for the image store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss",
+ "length": 255,
+ "name": "details",
+ "required": false,
+ "type": "map"
}
],
"related": "listSwifts,addImageStoreS3,listImageStores",
"response": [
{
+ "description": "the host's currently used disk size",
+ "name": "disksizeused",
+ "type": "long"
+ },
+ {
+ "description": "defines if store is read-only",
+ "name": "readonly",
+ "type": "boolean"
+ },
+ {
+ "description": "the protocol of the image store",
+ "name": "protocol",
+ "type": "string"
+ },
+ {
+ "description": "the provider name of the image store",
+ "name": "providername",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the ID of the image store",
+ "name": "id",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the Zone ID of the image store",
+ "name": "zoneid",
+ "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"
@@ -78834,18 +79985,13 @@
"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 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"
},
{
@@ -78854,47 +80000,11 @@
"type": "string"
},
{
- "description": "the ID of the image store",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the scope of the image store",
- "name": "scope",
- "type": "scopetype"
- },
- {},
- {
"description": "the Zone name of the image store",
"name": "zonename",
"type": "string"
},
- {
- "description": "the provider name of the image store",
- "name": "providername",
- "type": "string"
- },
- {
- "description": "defines if store is read-only",
- "name": "readonly",
- "type": "boolean"
- },
- {},
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the host's currently used disk size",
- "name": "disksizeused",
- "type": "long"
- },
- {
- "description": "the url of the image store",
- "name": "url",
- "type": "string"
- }
+ {}
],
"since": "4.3.0"
},
@@ -78904,43 +80014,6 @@
"name": "listAutoScalePolicies",
"params": [
{
- "description": "",
- "length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
- },
- {
- "description": "the ID of the condition of the policy",
- "length": 255,
- "name": "conditionid",
- "related": "",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "",
- "length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
- },
- {
- "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
- "length": 255,
- "name": "isrecursive",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "list only resources belonging to the domain specified",
- "length": 255,
- "name": "domainid",
- "related": "listDomainChildren,listDomains",
- "required": false,
- "type": "uuid"
- },
- {
"description": "List by keyword",
"length": 255,
"name": "keyword",
@@ -78948,6 +80021,21 @@
"type": "string"
},
{
+ "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false",
+ "length": 255,
+ "name": "listall",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "the ID of the autoscale vm group",
+ "length": 255,
+ "name": "vmgroupid",
+ "related": "listAutoScaleVmGroups",
+ "required": false,
+ "type": "uuid"
+ },
+ {
"description": "the action to be executed if all the conditions evaluate to true for the specified duration.",
"length": 255,
"name": "action",
@@ -78962,6 +80050,29 @@
"type": "string"
},
{
+ "description": "the ID of the condition of the policy",
+ "length": 255,
+ "name": "conditionid",
+ "related": "",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "list only resources belonging to the domain specified",
+ "length": 255,
+ "name": "domainid",
+ "related": "listDomainChildren,listDomains",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ },
+ {
"description": "the ID of the autoscale policy",
"length": 255,
"name": "id",
@@ -78970,17 +80081,16 @@
"type": "uuid"
},
{
- "description": "the ID of the autoscale vm group",
+ "description": "",
"length": 255,
- "name": "vmgroupid",
- "related": "listAutoScaleVmGroups",
+ "name": "pagesize",
"required": false,
- "type": "uuid"
+ "type": "integer"
},
{
- "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false",
+ "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"
}
@@ -78988,51 +80098,25 @@
"related": "",
"response": [
{
+ "description": "the domain ID of the autoscale policy",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
"description": "the domain name of the autoscale policy",
"name": "domain",
"type": "string"
},
{
- "description": "the account owning the autoscale policy",
- "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",
+ "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 duration for which the conditions have to be true before action is taken",
"name": "duration",
"type": "integer"
},
- {
- "description": "the autoscale policy ID",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the list of IDs of the conditions that are being evaluated on every interval",
- "name": "conditions",
- "type": "list"
- },
- {
- "description": "the project name of the autoscale policy",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
{},
{
"description": "the UUID of the latest async job acting on this object",
@@ -79040,13 +80124,39 @@
"type": "string"
},
{
+ "description": "the project name of the autoscale policy",
+ "name": "project",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the list of IDs of the conditions that are being evaluated on every interval",
+ "name": "conditions",
+ "type": "list"
+ },
+ {
+ "description": "the action to be executed if all the conditions evaluate to true for the specified duration.",
+ "name": "action",
+ "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",
+ "type": "string"
+ },
+ {
"description": "the project id autoscale policy",
"name": "projectid",
"type": "string"
},
{
- "description": "the domain ID of the autoscale policy",
- "name": "domainid",
+ "description": "the autoscale policy ID",
+ "name": "id",
"type": "string"
}
]
@@ -79067,22 +80177,22 @@
"related": "",
"response": [
{
- "description": "url",
- "name": "url",
- "type": "string"
- },
- {
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
{},
- {},
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
+ {},
+ {
+ "description": "url",
+ "name": "url",
+ "type": "string"
+ },
{
"description": "id of rct",
"name": "id",
@@ -79096,6 +80206,13 @@
"name": "updateRole",
"params": [
{
+ "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User",
+ "length": 255,
+ "name": "type",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "creates a role with this unique name",
"length": 255,
"name": "name",
@@ -79110,13 +80227,6 @@
"type": "string"
},
{
- "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User",
- "length": 255,
- "name": "type",
- "required": false,
- "type": "string"
- },
- {
"description": "ID of the role",
"length": 255,
"name": "id",
@@ -79134,27 +80244,6 @@
],
"related": "importRole,listRoles",
"response": [
- {},
- {
- "description": "the description of the role",
- "name": "description",
- "type": "string"
- },
- {
- "description": "the type of the role",
- "name": "type",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the ID of the role",
- "name": "id",
- "type": "string"
- },
{
"description": "the name of the role",
"name": "name",
@@ -79165,12 +80254,33 @@
"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 description of the role",
+ "name": "description",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the type of the role",
+ "name": "type",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the role",
+ "name": "id",
+ "type": "string"
+ }
],
"since": "4.9.0"
},
@@ -79180,6 +80290,13 @@
"name": "listVmwareDcs",
"params": [
{
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
"description": "List by keyword",
"length": 255,
"name": "keyword",
@@ -79187,13 +80304,6 @@
"type": "string"
},
{
- "description": "",
- "length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
- },
- {
"description": "Id of the CloudStack zone.",
"length": 255,
"name": "zoneid",
@@ -79204,7 +80314,7 @@
{
"description": "",
"length": 255,
- "name": "pagesize",
+ "name": "page",
"required": false,
"type": "integer"
}
@@ -79213,35 +80323,35 @@
"response": [
{},
{
- "description": "the Zone ID associated with this VMware Datacenter",
- "name": "zoneid",
- "type": "long"
- },
- {
- "description": "The VMware Datacenter name",
- "name": "name",
- "type": "string"
- },
- {},
- {
"description": "The VMware Datacenter ID",
"name": "id",
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
"description": "The VMware vCenter name/ip",
"name": "vcenter",
"type": "string"
},
+ {},
+ {
+ "description": "the Zone ID associated with this VMware Datacenter",
+ "name": "zoneid",
+ "type": "long"
+ },
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
+ },
+ {
+ "description": "The VMware Datacenter name",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
}
]
},
@@ -79251,35 +80361,6 @@
"name": "listZones",
"params": [
{
- "description": "the name of the zone",
- "length": 255,
- "name": "name",
- "required": false,
- "type": "string"
- },
- {
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the zone",
- "length": 255,
- "name": "domainid",
- "related": "listDomainChildren,listDomains",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "flag to display the capacity of the zones",
- "length": 255,
- "name": "showcapacities",
- "required": false,
- "type": "boolean"
- },
- {
"description": "the ID of the zone",
"length": 255,
"name": "id",
@@ -79288,27 +80369,6 @@
"type": "uuid"
},
{
- "description": "flag to display the resource image for the zones",
- "length": 255,
- "name": "showicon",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "the network type of the zone that the virtual machine belongs to",
- "length": 255,
- "name": "networktype",
- "required": false,
- "type": "string"
- },
- {
- "description": "",
- "length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
- },
- {
"description": "List zones by resource tags (key/value pairs)",
"length": 255,
"name": "tags",
@@ -79317,11 +80377,33 @@
"type": "map"
},
{
- "description": "",
+ "description": "the name of the zone",
"length": 255,
- "name": "pagesize",
+ "name": "name",
"required": false,
- "type": "integer"
+ "type": "string"
+ },
+ {
+ "description": "the network type of the zone that the virtual machine belongs to",
+ "length": 255,
+ "name": "networktype",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "flag to display the resource image for the zones",
+ "length": 255,
+ "name": "showicon",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "the ID of the domain associated with the zone",
+ "length": 255,
+ "name": "domainid",
+ "related": "listDomainChildren,listDomains",
+ "required": false,
+ "type": "uuid"
},
{
"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.",
@@ -79329,18 +80411,77 @@
"name": "available",
"required": false,
"type": "boolean"
+ },
+ {
+ "description": "flag to display the capacity of the zones",
+ "length": 255,
+ "name": "showcapacities",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "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"
}
],
"related": "createZone,listZones",
"response": [
{
- "description": "the guest CIDR address for the Zone",
- "name": "guestcidraddress",
+ "description": "the second internal DNS for the Zone",
+ "name": "internaldns2",
"type": "string"
},
{
- "description": "the second internal DNS for the Zone",
- "name": "internaldns2",
+ "description": "Zone Token",
+ "name": "zonetoken",
+ "type": "string"
+ },
+ {
+ "description": "Zone name",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the first DNS for the Zone",
+ "name": "dns1",
+ "type": "string"
+ },
+ {
+ "description": "Network domain name for the networks in the zone",
+ "name": "domain",
+ "type": "string"
+ },
+ {},
+ {
+ "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",
+ "type": "string"
+ },
+ {
+ "description": "the dhcp Provider for the Zone",
+ "name": "dhcpprovider",
"type": "string"
},
{
@@ -79349,8 +80490,126 @@
"type": "boolean"
},
{
- "description": "Zone id",
- "name": "id",
+ "description": "the second IPv6 DNS for the Zone",
+ "name": "ip6dns2",
+ "type": "string"
+ },
+ {
+ "description": "the allocation state of the cluster",
+ "name": "allocationstate",
+ "type": "string"
+ },
+ {
+ "description": "the first IPv6 DNS for the Zone",
+ "name": "ip6dns1",
+ "type": "string"
+ },
+ {
+ "description": "the display text of the zone",
+ "name": "displaytext",
+ "type": "string"
+ },
+ {
+ "description": "true if security groups support is enabled, false otherwise",
+ "name": "securitygroupsenabled",
+ "type": "boolean"
+ },
+ {},
+ {
+ "description": "the second DNS for the Zone",
+ "name": "dns2",
+ "type": "string"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the guest CIDR address for the Zone",
+ "name": "guestcidraddress",
+ "type": "string"
+ },
+ {
+ "description": "the list of resource tags associated with zone.",
+ "name": "tags",
+ "response": [
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "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"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "Zone description",
+ "name": "description",
+ "type": "string"
+ },
+ {
+ "description": "Meta data associated with the zone (key/value pairs)",
+ "name": "resourcedetails",
+ "type": "map"
+ },
+ {
+ "description": "the network type of the zone; can be Basic or Advanced",
+ "name": "networktype",
+ "type": "string"
+ },
+ {
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "description": "the name of the containing domain, null for public zones",
+ "name": "domainname",
"type": "string"
},
{
@@ -79358,8 +80617,18 @@
"name": "capacity",
"response": [
{
- "description": "the Zone name",
- "name": "zonename",
+ "description": "the capacity currently in use",
+ "name": "capacityused",
+ "type": "long"
+ },
+ {
+ "description": "the total capacity available",
+ "name": "capacitytotal",
+ "type": "long"
+ },
+ {
+ "description": "the percentage of capacity currently in use",
+ "name": "percentused",
"type": "string"
},
{
@@ -79373,9 +80642,9 @@
"type": "string"
},
{
- "description": "the capacity name",
- "name": "name",
- "type": "string"
+ "description": "the capacity currently in allocated",
+ "name": "capacityallocated",
+ "type": "long"
},
{
"description": "the capacity type",
@@ -79383,206 +80652,47 @@
"type": "short"
},
{
- "description": "the Cluster name",
- "name": "clustername",
- "type": "string"
- },
- {
- "description": "the capacity currently in use",
- "name": "capacityused",
- "type": "long"
- },
- {
- "description": "the Pod name",
- "name": "podname",
- "type": "string"
- },
- {
"description": "the Cluster ID",
"name": "clusterid",
"type": "string"
},
{
- "description": "the total capacity available",
- "name": "capacitytotal",
- "type": "long"
- },
- {
- "description": "the percentage of capacity currently in use",
- "name": "percentused",
+ "description": "the Cluster name",
+ "name": "clustername",
"type": "string"
},
{
- "description": "the capacity currently in allocated",
- "name": "capacityallocated",
- "type": "long"
+ "description": "the capacity name",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the Zone name",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "the Pod name",
+ "name": "podname",
+ "type": "string"
}
],
"type": "list"
},
{
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {},
- {
- "description": "the network type of the zone; can be Basic or Advanced",
- "name": "networktype",
+ "description": "Zone id",
+ "name": "id",
"type": "string"
},
{
- "description": "the allocation state of the cluster",
- "name": "allocationstate",
- "type": "string"
- },
- {
- "description": "the second IPv6 DNS for the Zone",
- "name": "ip6dns2",
- "type": "string"
- },
- {
- "description": "the name of the containing domain, null for public zones",
- "name": "domainname",
- "type": "string"
- },
- {
- "description": "the first IPv6 DNS for the Zone",
- "name": "ip6dns1",
- "type": "string"
- },
- {
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
- },
- {
- "description": "true if security groups support is enabled, false otherwise",
- "name": "securitygroupsenabled",
- "type": "boolean"
- },
- {
- "description": "Zone name",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the display text of the zone",
- "name": "displaytext",
- "type": "string"
- },
- {
- "description": "Meta data associated with the zone (key/value pairs)",
- "name": "resourcedetails",
- "type": "map"
- },
- {
"description": "the first internal DNS for the Zone",
"name": "internaldns1",
"type": "string"
},
{
- "description": "the first DNS for the Zone",
- "name": "dns1",
- "type": "string"
- },
- {
- "description": "the list of resource tags associated with zone.",
- "name": "tags",
- "response": [
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "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 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"
- }
- ],
- "type": "set"
- },
- {
- "description": "Zone description",
- "name": "description",
- "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",
- "type": "string"
- },
- {
- "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": "Zone Token",
- "name": "zonetoken",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the dhcp Provider for the Zone",
- "name": "dhcpprovider",
- "type": "string"
}
]
},
@@ -79592,13 +80702,11 @@
"name": "listRemoteAccessVpns",
"params": [
{
- "description": "list remote access VPNs for ceratin network",
+ "description": "List by keyword",
"length": 255,
- "name": "networkid",
- "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks",
+ "name": "keyword",
"required": false,
- "since": "4.3",
- "type": "uuid"
+ "type": "string"
},
{
"description": "list only resources belonging to the domain specified",
@@ -79609,13 +80717,28 @@
"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,
+ "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": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ },
+ {
"description": "Lists remote access vpn rule with the specified ID",
"length": 255,
"name": "id",
@@ -79625,6 +80748,22 @@
"type": "uuid"
},
{
+ "description": "list remote access VPNs for ceratin network",
+ "length": 255,
+ "name": "networkid",
+ "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks",
+ "required": false,
+ "since": "4.3",
+ "type": "uuid"
+ },
+ {
+ "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
+ "length": 255,
+ "name": "isrecursive",
+ "required": false,
+ "type": "boolean"
+ },
+ {
"description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false",
"length": 255,
"name": "listall",
@@ -79640,20 +80779,6 @@
"type": "uuid"
},
{
- "description": "",
- "length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
- },
- {
- "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
- "length": 255,
- "name": "isrecursive",
- "required": false,
- "type": "boolean"
- },
- {
"description": "list objects by project",
"length": 255,
"name": "projectid",
@@ -79662,21 +80787,6 @@
"type": "uuid"
},
{
- "description": "list resources by account. Must be used with the domainId parameter.",
- "length": 255,
- "name": "account",
- "required": false,
- "type": "string"
- },
- {
- "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter",
- "length": 255,
- "name": "fordisplay",
- "required": false,
- "since": "4.4",
- "type": "boolean"
- },
- {
"description": "",
"length": 255,
"name": "pagesize",
@@ -79687,16 +80797,15 @@
"related": "updateRemoteAccessVpn",
"response": [
{
- "description": "the id of the remote access vpn",
- "name": "id",
+ "description": "the range of ips to allocate to the clients",
+ "name": "iprange",
"type": "string"
},
{
- "description": "the domain name of the account of the remote access vpn",
- "name": "domain",
+ "description": "the project id of the vpn",
+ "name": "projectid",
"type": "string"
},
- {},
{
"description": "the state of the rule",
"name": "state",
@@ -79708,24 +80817,23 @@
"type": "string"
},
{
- "description": "the domain id of the account of the remote access vpn",
- "name": "domainid",
+ "description": "the public ip address of the vpn server",
+ "name": "publicip",
"type": "string"
},
{
- "description": "the range of ips to allocate to the clients",
- "name": "iprange",
+ "description": "the id of the remote access vpn",
+ "name": "id",
"type": "string"
},
{
- "description": "the project id of the vpn",
- "name": "projectid",
+ "description": "the domain name of the account of the remote access vpn",
+ "name": "domain",
"type": "string"
},
- {},
{
- "description": "the account of the remote access vpn",
- "name": "account",
+ "description": "the public ip address of the vpn server",
+ "name": "publicipid",
"type": "string"
},
{
@@ -79733,10 +80841,17 @@
"name": "project",
"type": "string"
},
+ {},
+ {},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "the domain id of the account of the remote access vpn",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the account of the remote access vpn",
+ "name": "account",
+ "type": "string"
},
{
"description": "is vpn for display to the regular user",
@@ -79744,14 +80859,9 @@
"type": "boolean"
},
{
- "description": "the public ip address of the vpn server",
- "name": "publicip",
- "type": "string"
- },
- {
- "description": "the public ip address of the vpn server",
- "name": "publicipid",
- "type": "string"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
{
"description": "the ipsec preshared key",
@@ -79775,6 +80885,13 @@
}
],
"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",
@@ -79789,14 +80906,7 @@
"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"
- },
- {},
- {}
+ }
]
},
{
@@ -79816,26 +80926,26 @@
"response": [
{},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "any text associated with the success or failure",
+ "name": "displaytext",
+ "type": "string"
},
+ {},
{
"description": "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"
+ }
]
},
{
@@ -79844,6 +80954,13 @@
"name": "createServiceInstance",
"params": [
{
+ "description": "An optional account for the virtual machine. Must be used with domainId.",
+ "length": 255,
+ "name": "account",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "An optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.",
"length": 255,
"name": "domainid",
@@ -79852,6 +80969,22 @@
"type": "uuid"
},
{
+ "description": "The left (inside) network for service instance",
+ "length": 255,
+ "name": "leftnetworkid",
+ "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks",
+ "required": true,
+ "type": "uuid"
+ },
+ {
+ "description": "Project ID for the service instance",
+ "length": 255,
+ "name": "projectid",
+ "related": "activateProject,suspendProject",
+ "required": false,
+ "type": "uuid"
+ },
+ {
"description": "The service offering ID that defines the resources consumed by the service appliance",
"length": 255,
"name": "serviceofferingid",
@@ -79860,18 +80993,19 @@
"type": "uuid"
},
{
- "description": "An optional account for the virtual machine. Must be used with domainId.",
+ "description": "Availability zone for the service instance",
"length": 255,
- "name": "account",
- "required": false,
- "type": "string"
+ "name": "zoneid",
+ "related": "createZone,listZones",
+ "required": true,
+ "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": "activateProject,suspendProject",
- "required": false,
+ "name": "templateid",
+ "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos",
+ "required": true,
"type": "uuid"
},
{
@@ -79888,47 +81022,19 @@
"related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks",
"required": true,
"type": "uuid"
- },
- {
- "description": "The template ID that specifies the image for the service appliance",
- "length": 255,
- "name": "templateid",
- "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos",
- "required": true,
- "type": "uuid"
- },
- {
- "description": "Availability zone for the service instance",
- "length": 255,
- "name": "zoneid",
- "related": "createZone,listZones",
- "required": true,
- "type": "uuid"
- },
- {
- "description": "The left (inside) network for service instance",
- "length": 255,
- "name": "leftnetworkid",
- "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks",
- "required": true,
- "type": "uuid"
}
],
"related": "",
"response": [
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the account 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 project id of the vm",
- "name": "projectid",
+ "description": "the ID of the virtual machine",
+ "name": "id",
"type": "string"
},
{
@@ -79937,13 +81043,23 @@
"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 ID of the domain in which the virtual machine exists",
"name": "domainid",
"type": "string"
},
{
- "description": "the project name of the vm",
- "name": "project",
+ "description": "the project id of the vm",
+ "name": "projectid",
"type": "string"
},
{
@@ -79952,22 +81068,16 @@
"type": "string"
},
{
- "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": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the account associated with the virtual machine",
+ "name": "account",
"type": "string"
- },
- {}
+ }
]
},
{
@@ -79985,6 +81095,18 @@
}
],
"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",
@@ -79994,19 +81116,7 @@
"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"
- },
- {},
- {}
+ }
]
},
{
@@ -80030,51 +81140,42 @@
"type": "integer"
},
{
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
- },
- {
"description": "",
"length": 255,
"name": "page",
"required": false,
"type": "integer"
+ },
+ {
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
}
],
"related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listBrocadeVcsDeviceNetworks",
"response": [
+ {},
{
- "description": "The external id of the network",
- "name": "externalid",
+ "description": "availability of the network offering the network is created from",
+ "name": "networkofferingavailability",
"type": "string"
},
{
- "description": "the owner of the network",
- "name": "account",
+ "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes",
+ "name": "reservediprange",
"type": "string"
},
{
- "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans",
- "name": "zonesnetworkspans",
- "type": "set"
- },
- {
- "description": "zone id of the network",
- "name": "zoneid",
+ "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": "list networks available for vm deployment",
- "name": "canusefordeploy",
- "type": "boolean"
- },
- {
- "description": "true if users from subdomains can access the domain level network",
- "name": "subdomainaccess",
- "type": "boolean"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
{
"description": "the name of the network",
@@ -80082,87 +81183,20 @@
"type": "string"
},
{
- "description": "ACL name associated with the VPC network",
- "name": "aclname",
+ "description": "The external id of the network",
+ "name": "externalid",
"type": "string"
},
{
- "description": "network offering id the network is created from",
- "name": "networkofferingid",
+ "description": "zone id of the network",
+ "name": "zoneid",
"type": "string"
},
{
- "description": "the details of the network",
- "name": "details",
- "type": "map"
- },
- {
- "description": "the domain id of the network owner",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "display text of the network offering the network is created from",
- "name": "networkofferingdisplaytext",
- "type": "string"
- },
- {
- "description": "the first DNS for the network",
- "name": "dns1",
- "type": "string"
- },
- {
- "description": "The vlan of the network. This parameter is visible to ROOT admins only",
- "name": "vlan",
- "type": "string"
- },
- {
- "description": "related to what other network configuration",
- "name": "related",
- "type": "string"
- },
- {
- "description": "the project name of the address",
- "name": "project",
- "type": "string"
- },
- {
- "description": "true if network is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
- },
- {
- "description": "the date this network was created",
- "name": "created",
- "type": "date"
- },
- {
"description": "the list of services",
"name": "service",
"response": [
{
- "description": "the list of capabilities",
- "name": "capability",
- "response": [
- {
- "description": "the capability value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "the capability name",
- "name": "name",
- "type": "string"
- },
- {
- "description": "can this service capability value can be choosable while creatine network offerings",
- "name": "canchooseservicecapability",
- "type": "boolean"
- }
- ],
- "type": "list"
- },
- {
"description": "the service name",
"name": "name",
"type": "string"
@@ -80172,18 +81206,23 @@
"name": "provider",
"response": [
{
+ "description": "the provider name",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "state of the network provider",
+ "name": "state",
+ "type": "string"
+ },
+ {
"description": "uuid of the network provider",
"name": "id",
"type": "string"
},
{
- "description": "the destination physical network",
- "name": "destinationphysicalnetworkid",
- "type": "string"
- },
- {
- "description": "the provider name",
- "name": "name",
+ "description": "the physical network this belongs to",
+ "name": "physicalnetworkid",
"type": "string"
},
{
@@ -80192,18 +81231,35 @@
"type": "list"
},
{
- "description": "state of the network provider",
- "name": "state",
+ "description": "the destination physical network",
+ "name": "destinationphysicalnetworkid",
"type": "string"
},
{
"description": "true if individual services can be enabled/disabled",
"name": "canenableindividualservice",
"type": "boolean"
+ }
+ ],
+ "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 physical network this belongs to",
- "name": "physicalnetworkid",
+ "description": "the capability value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "the capability name",
+ "name": "name",
"type": "string"
}
],
@@ -80212,10 +81268,29 @@
],
"type": "list"
},
- {},
{
- "description": "the second DNS for the network",
- "name": "dns2",
+ "description": "list networks available for vm deployment",
+ "name": "canusefordeploy",
+ "type": "boolean"
+ },
+ {
+ "description": "true if network offering is ip conserve mode enabled",
+ "name": "networkofferingconservemode",
+ "type": "boolean"
+ },
+ {
+ "description": "the domain id of the network owner",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "true if network is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {
+ "description": "ACL name associated with the VPC network",
+ "name": "aclname",
"type": "string"
},
{
@@ -80224,100 +81299,23 @@
"type": "string"
},
{
- "description": "VPC the network belongs to",
- "name": "vpcid",
- "type": "string"
- },
- {
- "description": "the list of resource tags associated with network",
- "name": "tags",
- "response": [
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "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": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- }
- ],
- "type": "list"
- },
- {
- "description": "the network domain",
- "name": "networkdomain",
- "type": "string"
- },
- {
- "description": "list networks that are persistent",
- "name": "ispersistent",
+ "description": "If the network has redundant routers enabled",
+ "name": "redundantrouter",
"type": "boolean"
},
{
- "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR",
- "name": "cidr",
+ "description": "the project name of the address",
+ "name": "project",
"type": "string"
},
{
- "description": "the domain name of the network owner",
- "name": "domain",
+ "description": "the type of the network",
+ "name": "type",
"type": "string"
},
{
- "description": "acl type - access type to the network",
- "name": "acltype",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "true if network offering is ip conserve mode enabled",
- "name": "networkofferingconservemode",
+ "description": "true if network can span multiple zones",
+ "name": "strechedl2subnet",
"type": "boolean"
},
{
@@ -80331,13 +81329,38 @@
"type": "boolean"
},
{
- "description": "the physical network id",
- "name": "physicalnetworkid",
+ "description": "ACL Id associated with the VPC network",
+ "name": "aclid",
"type": "string"
},
{
- "description": "the id of the network",
- "name": "id",
+ "description": "true if users from subdomains can access the domain level network",
+ "name": "subdomainaccess",
+ "type": "boolean"
+ },
+ {
+ "description": "the network's gateway",
+ "name": "gateway",
+ "type": "string"
+ },
+ {
+ "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR",
+ "name": "cidr",
+ "type": "string"
+ },
+ {
+ "description": "the second DNS for the network",
+ "name": "dns2",
+ "type": "string"
+ },
+ {
+ "description": "VPC the network belongs to",
+ "name": "vpcid",
+ "type": "string"
+ },
+ {
+ "description": "acl type - access type to the network",
+ "name": "acltype",
"type": "string"
},
{
@@ -80346,14 +81369,13 @@
"type": "boolean"
},
{
- "description": "name of the network offering the network is created from",
- "name": "networkofferingname",
+ "description": "the project id of the ipaddress",
+ "name": "projectid",
"type": "string"
},
- {},
{
- "description": "the gateway of IPv6 network",
- "name": "ip6gateway",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
@@ -80362,58 +81384,115 @@
"type": "string"
},
{
- "description": "the traffic type of the network",
- "name": "traffictype",
- "type": "string"
- },
- {
- "description": "ACL Id associated with the VPC network",
- "name": "aclid",
- "type": "string"
- },
- {
- "description": "the network's gateway",
- "name": "gateway",
- "type": "string"
- },
- {
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
- },
- {
"description": "the name of the zone the network belongs to",
"name": "zonename",
"type": "string"
},
{
+ "description": "related to what other network configuration",
+ "name": "related",
+ "type": "string"
+ },
+ {
+ "description": "the traffic type of the network",
+ "name": "traffictype",
+ "type": "string"
+ },
+ {
"description": "true if network is system, false otherwise",
"name": "issystem",
"type": "boolean"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "display text of the network offering the network is created from",
+ "name": "networkofferingdisplaytext",
"type": "string"
},
{
- "description": "availability of the network offering the network is created from",
- "name": "networkofferingavailability",
+ "description": "network offering id the network is created from",
+ "name": "networkofferingid",
"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": "the network's netmask",
- "name": "netmask",
+ "description": "the list of resource tags associated with network",
+ "name": "tags",
+ "response": [
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "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": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ }
+ ],
+ "type": "list"
+ },
+ {
+ "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans",
+ "name": "zonesnetworkspans",
+ "type": "set"
+ },
+ {
+ "description": "list networks that are persistent",
+ "name": "ispersistent",
+ "type": "boolean"
+ },
+ {
+ "description": "the id of the network",
+ "name": "id",
"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 gateway of IPv6 network",
+ "name": "ip6gateway",
"type": "string"
},
{
@@ -80427,18 +81506,8 @@
"type": "string"
},
{
- "description": "the project id of the ipaddress",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "If the network has redundant routers enabled",
- "name": "redundantrouter",
- "type": "boolean"
- },
- {
- "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes",
- "name": "reservediprange",
+ "description": "the first DNS for the network",
+ "name": "dns1",
"type": "string"
},
{
@@ -80447,28 +81516,69 @@
"type": "string"
},
{
- "description": "state of the network",
- "name": "state",
- "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": "the network domain",
+ "name": "networkdomain",
+ "type": "string"
+ },
+ {
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {},
+ {
"description": "true network requires restart",
"name": "restartrequired",
"type": "boolean"
},
{
- "description": "true if network can span multiple zones",
- "name": "strechedl2subnet",
- "type": "boolean"
+ "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",
+ "description": "the details of the network",
+ "name": "details",
+ "type": "map"
+ },
+ {
+ "description": "name of the network offering the network is created from",
+ "name": "networkofferingname",
+ "type": "string"
+ },
+ {
+ "description": "The vlan of the network. This parameter is visible to ROOT admins only",
+ "name": "vlan",
+ "type": "string"
+ },
+ {
+ "description": "the domain name of the network owner",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "state of the network",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "the date this network was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the owner of the network",
+ "name": "account",
"type": "string"
}
]
@@ -80490,119 +81600,30 @@
"related": "migrateSystemVm",
"response": [
{
- "description": "the Pod ID for the system VM",
- "name": "podid",
+ "description": "the host ID for the system VM",
+ "name": "hostid",
"type": "string"
},
{},
{
- "description": "the hypervisor on which the template runs",
- "name": "hypervisor",
- "type": "string"
- },
- {
- "description": "the hostname for the system VM",
- "name": "hostname",
- "type": "string"
- },
- {
- "description": "the private netmask for the system VM",
- "name": "privatenetmask",
- "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 number of active console sessions for the console proxy system vm",
- "name": "activeviewersessions",
- "type": "integer"
- },
- {
- "description": "the systemvm agent version",
- "name": "version",
- "type": "string"
- },
- {
- "description": "the state of the system VM",
- "name": "state",
- "type": "string"
- },
- {
- "description": "the date and time the system VM was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the ID of the system VM",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the link local IP address for the system vm",
- "name": "linklocalip",
- "type": "string"
- },
- {
- "description": "the network domain for the system VM",
- "name": "networkdomain",
- "type": "string"
- },
- {
- "description": "public vlan range",
- "name": "publicvlan",
- "type": "list"
- },
- {
- "description": "the private IP address for the system VM",
- "name": "privateip",
- "type": "string"
- },
- {
"description": "the private MAC address for the system VM",
"name": "privatemacaddress",
"type": "string"
},
+ {},
{
- "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.",
- "name": "isdynamicallyscalable",
- "type": "boolean"
- },
- {
- "description": "the first DNS for the system VM",
- "name": "dns1",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
+ "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 gateway for the system VM",
- "name": "gateway",
- "type": "string"
- },
- {
"description": "the public IP address for the system VM",
"name": "publicip",
"type": "string"
},
{
- "description": "the Zone ID for the system VM",
- "name": "zoneid",
- "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": "guest vlan range",
+ "name": "guestvlan",
"type": "string"
},
{
@@ -80611,19 +81632,19 @@
"type": "string"
},
{
- "description": "the template name for the system VM",
- "name": "templatename",
+ "description": "the link local IP address for the system vm",
+ "name": "linklocalip",
"type": "string"
},
{
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
+ "description": "the Zone ID for the system VM",
+ "name": "zoneid",
+ "type": "string"
},
{
- "description": "the second DNS for the system VM",
- "name": "dns2",
- "type": "string"
+ "description": "public vlan range",
+ "name": "publicvlan",
+ "type": "list"
},
{
"description": "the link local netmask for the system vm",
@@ -80631,60 +81652,149 @@
"type": "string"
},
{
- "description": "the system VM type",
- "name": "systemvmtype",
- "type": "string"
- },
- {
- "description": "the host ID for the system VM",
- "name": "hostid",
- "type": "string"
- },
- {
- "description": "the public netmask for the system VM",
- "name": "publicnetmask",
- "type": "string"
- },
- {},
- {
- "description": "guest vlan range",
- "name": "guestvlan",
- "type": "string"
- },
- {
- "description": "the template ID for the system VM",
- "name": "templateid",
- "type": "string"
- },
- {
- "description": "the name of the system VM",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the Pod name for the system VM",
- "name": "podname",
- "type": "string"
- },
- {
- "description": "the public MAC address for the system VM",
- "name": "publicmacaddress",
- "type": "string"
- },
- {
"description": "the Zone name for the system VM",
"name": "zonename",
"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 public MAC address for the system VM",
+ "name": "publicmacaddress",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the system VM",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
{
+ "description": "the hypervisor on which the template runs",
+ "name": "hypervisor",
+ "type": "string"
+ },
+ {
+ "description": "the private IP address for the system VM",
+ "name": "privateip",
+ "type": "string"
+ },
+ {
+ "description": "the first DNS for the system VM",
+ "name": "dns1",
+ "type": "string"
+ },
+ {
+ "description": "the name of the system VM",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the network domain for the system VM",
+ "name": "networkdomain",
+ "type": "string"
+ },
+ {
+ "description": "the template name for the system VM",
+ "name": "templatename",
+ "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 hostname for the system VM",
+ "name": "hostname",
+ "type": "string"
+ },
+ {
+ "description": "the second DNS for the system VM",
+ "name": "dns2",
+ "type": "string"
+ },
+ {
+ "description": "the gateway for the system VM",
+ "name": "gateway",
+ "type": "string"
+ },
+ {
+ "description": "the public netmask for the system VM",
+ "name": "publicnetmask",
+ "type": "string"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the template ID for the system VM",
+ "name": "templateid",
+ "type": "string"
+ },
+ {
+ "description": "the systemvm agent version",
+ "name": "version",
+ "type": "string"
+ },
+ {
"description": "the agent state of the system VM",
"name": "agentstate",
"type": "string"
+ },
+ {
+ "description": "the system VM type",
+ "name": "systemvmtype",
+ "type": "string"
+ },
+ {
+ "description": "the Pod ID for the system VM",
+ "name": "podid",
+ "type": "string"
+ },
+ {
+ "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": "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 date and time the system VM was created",
+ "name": "created",
+ "type": "date"
}
]
},
@@ -80696,14 +81806,14 @@
{
"description": "",
"length": 255,
- "name": "page",
+ "name": "pagesize",
"required": false,
"type": "integer"
},
{
"description": "",
"length": 255,
- "name": "pagesize",
+ "name": "page",
"required": false,
"type": "integer"
},
@@ -80718,15 +81828,15 @@
"related": "",
"response": [
{
- "description": "Network isolation method name",
- "name": "name",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{},
{},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "Network isolation method name",
+ "name": "name",
"type": "string"
},
{
@@ -80753,10 +81863,22 @@
],
"related": "configureHAForHost,enableHAForHost,disableHAForHost,listHostHAProviders",
"response": [
+ {},
{
- "description": "the HA state of the host",
- "name": "hastate",
- "type": "hastate"
+ "description": "the host HA provider",
+ "name": "haprovider",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the host",
+ "name": "hostid",
+ "type": "string"
},
{
"description": "the current status of the latest async job acting on this object",
@@ -80769,21 +81891,9 @@
"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 HA state of the host",
+ "name": "hastate",
+ "type": "hastate"
},
{
"description": "if host HA is enabled for the host",
@@ -80810,159 +81920,8 @@
"related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost",
"response": [
{
- "description": "the amount of the host's memory after applying the mem.overprovisioning.factor",
- "name": "memorywithoverprovisioning",
- "type": "string"
- },
- {
- "description": "the amount of the host's memory currently allocated in percentage",
- "name": "memoryallocatedpercentage",
- "type": "string"
- },
- {
- "description": "the amount of the host's memory currently used",
- "name": "memoryused",
- "type": "long"
- },
- {
- "description": "the outgoing network traffic on the host",
- "name": "networkkbswrite",
- "type": "long"
- },
- {
- "description": "the host's currently allocated disk size",
- "name": "disksizeallocated",
- "type": "long"
- },
- {
- "description": "the cpu average load on the host",
- "name": "cpuloadaverage",
- "type": "double"
- },
- {
- "description": "true if the host is disconnected. False otherwise.",
- "name": "disconnected",
- "type": "date"
- },
- {
- "description": "the ID of the host",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the host HA information information",
- "name": "hostha",
- "type": "hostharesponse"
- },
- {
- "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 in percentage",
- "name": "cpuallocatedpercentage",
- "type": "string"
- },
- {
- "description": "the date and time the host was removed",
- "name": "removed",
- "type": "date"
- },
- {
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "the host type",
- "name": "type",
- "type": "type"
- },
- {
- "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 host out-of-band management information",
- "name": "outofbandmanagement",
- "type": "outofbandmanagementresponse"
- },
- {
- "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise",
- "name": "hahost",
- "type": "boolean"
- },
- {
- "description": "the date and time the host was last pinged",
- "name": "lastpinged",
- "type": "date"
- },
- {
- "description": "the OS category name of the host",
- "name": "oscategoryname",
- "type": "string"
- },
- {
- "description": "the admin that annotated this host",
- "name": "username",
- "type": "string"
- },
- {
- "description": "the Zone name of the host",
- "name": "zonename",
- "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 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": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "capabilities of the host",
- "name": "capabilities",
- "type": "string"
- },
- {
- "description": "the CPU number of the host",
- "name": "cpunumber",
- "type": "integer"
- },
- {
- "description": "true if the host has capability to support UEFI boot",
- "name": "ueficapability",
- "type": "boolean"
- },
- {},
- {
- "description": "the resource state of the host",
- "name": "resourcestate",
+ "description": "the cluster type of the cluster that host belongs to",
+ "name": "clustertype",
"type": "string"
},
{
@@ -80971,119 +81930,116 @@
"type": "date"
},
{
- "description": "the cluster type of the cluster that host belongs to",
- "name": "clustertype",
+ "description": "true if the host is disconnected. False otherwise.",
+ "name": "disconnected",
+ "type": "date"
+ },
+ {
+ "description": "capabilities of the host",
+ "name": "capabilities",
"type": "string"
},
{
- "description": "the number of CPU sockets on the host",
- "name": "cpusockets",
- "type": "integer"
+ "description": "the incoming network traffic on the host",
+ "name": "networkkbsread",
+ "type": "long"
},
{
+ "description": "the date and time the host was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the amount of the host's CPU currently allocated in MHz",
+ "name": "cpuallocatedvalue",
+ "type": "long"
+ },
+ {
+ "description": "the host HA information information",
+ "name": "hostha",
+ "type": "hostharesponse"
+ },
+ {
+ "description": "the amount of the host's memory currently allocated in percentage",
+ "name": "memoryallocatedpercentage",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the host's memory currently allocated in bytes",
+ "name": "memoryallocatedbytes",
+ "type": "long"
+ },
+ {},
+ {
+ "description": "the Zone name of the host",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "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 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",
- "type": "string"
- },
- {
- "description": "the hypervisor version",
- "name": "hypervisorversion",
- "type": "string"
- },
- {
- "description": "true if local storage is active, false otherwise",
- "name": "islocalstorageactive",
- "type": "boolean"
- },
- {
- "description": "the Pod ID of the host",
- "name": "podid",
- "type": "string"
- },
- {
- "description": "the CPU speed of the host",
- "name": "cpuspeed",
- "type": "long"
- },
- {
- "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor",
- "name": "cpuallocatedwithoverprovisioning",
- "type": "string"
- },
- {
- "description": "the last annotation set on this host by an admin",
- "name": "annotation",
- "type": "string"
- },
- {
- "description": "Host details in key/value pairs.",
- "name": "details",
- "type": "map"
- },
- {
- "description": "the state of the host",
- "name": "state",
- "type": "status"
- },
- {
- "description": "the amount of the host's memory currently allocated",
- "name": "memoryallocated",
- "type": "long"
- },
- {
- "description": "the host version",
- "name": "version",
- "type": "string"
- },
- {
"description": "events available for the host",
"name": "events",
"type": "string"
},
{
- "description": "the OS category ID of the host",
- "name": "oscategoryid",
+ "description": "the last annotation set on this host by an admin",
+ "name": "annotation",
"type": "string"
},
{
- "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",
- "name": "cpuallocated",
- "type": "string"
+ "description": "the CPU speed of the host",
+ "name": "cpuspeed",
+ "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": "Maximum Y resolution per display",
+ "name": "maxresolutiony",
+ "type": "long"
+ },
+ {
"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",
+ "type": "long"
+ },
+ {
+ "description": "Maximum no. of vgpu per gpu card (pgpu)",
+ "name": "maxvgpuperpgpu",
+ "type": "long"
+ },
+ {
+ "description": "Maximum vgpu can be created with this vgpu type on the given gpu group",
+ "name": "maxcapacity",
+ "type": "long"
+ },
+ {
"description": "Maximum displays per user",
"name": "maxheads",
"type": "long"
@@ -81094,39 +82050,79 @@
"type": "string"
},
{
- "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": "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 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 amount of the host's CPU currently allocated in MHz",
- "name": "cpuallocatedvalue",
+ "description": "the host version",
+ "name": "version",
+ "type": "string"
+ },
+ {
+ "description": "the CPU number of the host",
+ "name": "cpunumber",
+ "type": "integer"
+ },
+ {
+ "description": "the cluster ID of the host",
+ "name": "clusterid",
+ "type": "string"
+ },
+ {
+ "description": "the OS category ID of the host",
+ "name": "oscategoryid",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the host's CPU currently used",
+ "name": "cpuused",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the host",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "true if the host has capability to support UEFI boot",
+ "name": "ueficapability",
+ "type": "boolean"
+ },
+ {
+ "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise",
+ "name": "hasenoughcapacity",
+ "type": "boolean"
+ },
+ {
+ "description": "the cpu average load on the host",
+ "name": "cpuloadaverage",
+ "type": "double"
+ },
+ {
+ "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise",
+ "name": "hahost",
+ "type": "boolean"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the outgoing network traffic on the host",
+ "name": "networkkbswrite",
"type": "long"
},
{
@@ -81135,28 +82131,98 @@
"type": "string"
},
{
- "description": "the amount of the host's memory currently allocated in bytes",
- "name": "memoryallocatedbytes",
+ "description": "the hypervisor version",
+ "name": "hypervisorversion",
+ "type": "string"
+ },
+ {
+ "description": "true if local storage is active, false otherwise",
+ "name": "islocalstorageactive",
+ "type": "boolean"
+ },
+ {
+ "description": "comma-separated list of tags for the host",
+ "name": "hosttags",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning",
+ "name": "memorytotal",
"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 OS category name of the host",
+ "name": "oscategoryname",
+ "type": "string"
+ },
+ {
"description": "the management server ID of the host",
"name": "managementserverid",
"type": "string"
},
{
- "description": "the incoming network traffic on the host",
- "name": "networkkbsread",
+ "description": "the amount of the host's CPU currently allocated",
+ "name": "cpuallocated",
+ "type": "string"
+ },
+ {
+ "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",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the host's memory currently used",
+ "name": "memoryused",
"type": "long"
},
{
- "description": "the host hypervisor",
- "name": "hypervisor",
- "type": "hypervisortype"
+ "description": "the host's currently allocated disk size",
+ "name": "disksizeallocated",
+ "type": "long"
},
{
- "description": "the amount of the host's CPU currently used",
- "name": "cpuused",
+ "description": "the IP address of the host",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "the Pod ID of the host",
+ "name": "podid",
+ "type": "string"
+ },
+ {
+ "description": "Host details in key/value pairs.",
+ "name": "details",
+ "type": "map"
+ },
+ {
+ "description": "the admin that annotated this host",
+ "name": "username",
+ "type": "string"
+ },
+ {
+ "description": "the host out-of-band management information",
+ "name": "outofbandmanagement",
+ "type": "outofbandmanagementresponse"
+ },
+ {
+ "description": "the cluster name of the host",
+ "name": "clustername",
"type": "string"
},
{
@@ -81165,25 +82231,411 @@
"type": "integer"
},
{
- "description": "the cluster ID of the host",
- "name": "clusterid",
+ "description": "the resource state of the host",
+ "name": "resourcestate",
"type": "string"
},
- {}
+ {
+ "description": "the amount of the host's memory after applying the mem.overprovisioning.factor",
+ "name": "memorywithoverprovisioning",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor",
+ "name": "cpuallocatedwithoverprovisioning",
+ "type": "string"
+ },
+ {
+ "description": "the host type",
+ "name": "type",
+ "type": "type"
+ },
+ {
+ "description": "the name of the host",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "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": "the state of the host",
+ "name": "state",
+ "type": "status"
+ },
+ {
+ "description": "the number of CPU sockets on the host",
+ "name": "cpusockets",
+ "type": "integer"
+ },
+ {
+ "description": "the host hypervisor",
+ "name": "hypervisor",
+ "type": "hypervisortype"
+ }
],
"since": "4.16.0.0"
},
{
+ "description": "Creates a Kubernetes cluster",
+ "isasync": true,
+ "name": "createKubernetesCluster",
+ "params": [
+ {
+ "description": "Network in which Kubernetes cluster is to be launched",
+ "length": 255,
+ "name": "networkid",
+ "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listBrocadeVcsDeviceNetworks",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "the ID of the service offering for the virtual machines in the cluster.",
+ "length": 255,
+ "name": "serviceofferingid",
+ "related": "updateServiceOffering,listServiceOfferings",
+ "required": true,
+ "type": "uuid"
+ },
+ {
+ "description": "email of the docker image private registry user",
+ "length": 255,
+ "name": "dockerregistryemail",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "name of the ssh key pair used to login to the virtual machines",
+ "length": 255,
+ "name": "keypair",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "URL for the docker image private registry",
+ "length": 255,
+ "name": "dockerregistryurl",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "an optional account for the virtual machine. Must be used with domainId.",
+ "length": 255,
+ "name": "account",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "description for the Kubernetes cluster",
+ "length": 255,
+ "name": "description",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "external load balancer IP address while using shared network with Kubernetes HA cluster",
+ "length": 255,
+ "name": "externalloadbalanceripaddress",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.",
+ "length": 255,
+ "name": "domainid",
+ "related": "listDomainChildren,listDomains",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "number of Kubernetes cluster worker nodes",
+ "length": 255,
+ "name": "size",
+ "required": true,
+ "type": "long"
+ },
+ {
+ "description": "name for the Kubernetes cluster",
+ "length": 255,
+ "name": "name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "number of Kubernetes cluster master nodes, default is 1. This option is deprecated, please use 'controlnodes' parameter.",
+ "length": 255,
+ "name": "masternodes",
+ "required": false,
+ "type": "long"
+ },
+ {
+ "description": "Deploy cluster for the project",
+ "length": 255,
+ "name": "projectid",
+ "related": "activateProject,suspendProject",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "Kubernetes version with which cluster to be launched",
+ "length": 255,
+ "name": "kubernetesversionid",
+ "related": "listKubernetesSupportedVersions",
+ "required": true,
+ "type": "uuid"
+ },
+ {
+ "description": "number of Kubernetes cluster control nodes, default is 1",
+ "length": 255,
+ "name": "controlnodes",
+ "required": false,
+ "type": "long"
+ },
+ {
+ "description": "password for the docker image private registry",
+ "length": 255,
+ "name": "dockerregistrypassword",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "user name for the docker image private registry",
+ "length": 255,
+ "name": "dockerregistryusername",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "availability zone in which Kubernetes cluster to be launched",
+ "length": 255,
+ "name": "zoneid",
+ "related": "createZone,listZones",
+ "required": true,
+ "type": "uuid"
+ },
+ {
+ "description": "root disk size in GB for each node",
+ "length": 255,
+ "name": "noderootdisksize",
+ "required": false,
+ "type": "long"
+ }
+ ],
+ "related": "startKubernetesCluster",
+ "response": [
+ {
+ "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.",
+ "name": "masternodes",
+ "type": "long"
+ },
+ {
+ "description": "Public IP Address of the cluster",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "URL end point for the Kubernetes cluster",
+ "name": "endpoint",
+ "type": "string"
+ },
+ {
+ "description": "the control nodes count for the Kubernetes cluster",
+ "name": "controlnodes",
+ "type": "long"
+ },
+ {
+ "description": "the ID of the network of the Kubernetes cluster",
+ "name": "networkid",
+ "type": "string"
+ },
+ {
+ "description": "Public IP Address ID of the cluster",
+ "name": "ipaddressid",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting 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 domain in which the Kubernetes cluster exists",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "keypair details",
+ "name": "keypair",
+ "type": "string"
+ },
+ {
+ "description": "the name of the Kubernetes cluster",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the name of the network of the Kubernetes cluster",
+ "name": "associatednetworkname",
+ "type": "string"
+ },
+ {
+ "description": "Maximum size of the cluster",
+ "name": "maxsize",
+ "type": "long"
+ },
+ {
+ "description": "the ID of the Kubernetes version for the Kubernetes cluster",
+ "name": "kubernetesversionid",
+ "type": "string"
+ },
+ {
+ "description": "the list of virtualmachine associated with this Kubernetes cluster",
+ "name": "virtualmachines",
+ "type": "list"
+ },
+ {
+ "description": "the name of the Kubernetes version for the Kubernetes cluster",
+ "name": "kubernetesversionname",
+ "type": "string"
+ },
+ {
+ "description": "the id of the Kubernetes cluster",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the name of the service offering of the Kubernetes cluster",
+ "name": "serviceofferingname",
+ "type": "string"
+ },
+ {
+ "description": "the state of the Kubernetes cluster",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the ID of the template of the Kubernetes cluster",
+ "name": "templateid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "Minimum size of the cluster",
+ "name": "minsize",
+ "type": "long"
+ },
+ {
+ "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": "Whether autoscaling is enabled for the cluster",
+ "name": "autoscalingenabled",
+ "type": "boolean"
+ },
+ {
+ "description": "the name of the domain in which the Kubernetes cluster exists",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the project id of the Kubernetes cluster",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the zone of the Kubernetes cluster",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the Kubernetes cluster",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the name of the zone of the Kubernetes cluster",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the memory the Kubernetes cluster",
+ "name": "memory",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the service offering of the Kubernetes cluster",
+ "name": "serviceofferingid",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the Kubernetes cluster",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the cpu cores of the Kubernetes cluster",
+ "name": "cpunumber",
+ "type": "string"
+ },
+ {
+ "description": "URL end point for the Kubernetes cluster dashboard UI",
+ "name": "consoleendpoint",
+ "type": "string"
+ }
+ ]
+ },
+ {
"description": "List a storage network IP range.",
"isasync": false,
"name": "listStorageNetworkIpRange",
"params": [
{
- "description": "List by keyword",
+ "description": "optional parameter. Pod uuid, if specicied and range uuid is absent, using it to search the range.",
"length": 255,
- "name": "keyword",
+ "name": "podid",
+ "related": "updatePod,createManagementNetworkIpRange",
"required": false,
- "type": "string"
+ "type": "uuid"
+ },
+ {
+ "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": "createZone,listZones",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
},
{
"description": "optional parameter. Storaget network IP range uuid, if specicied, using it to search the range.",
@@ -81201,54 +82653,29 @@
"type": "integer"
},
{
- "description": "",
+ "description": "List by keyword",
"length": 255,
- "name": "pagesize",
+ "name": "keyword",
"required": false,
- "type": "integer"
- },
- {
- "description": "optional parameter. Pod uuid, if specicied and range uuid is absent, using it to search the range.",
- "length": 255,
- "name": "podid",
- "related": "updatePod,createManagementNetworkIpRange",
- "required": false,
- "type": "uuid"
- },
- {
- "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": "createZone,listZones",
- "required": false,
- "type": "uuid"
+ "type": "string"
}
],
"related": "createStorageNetworkIpRange",
"response": [
{
- "description": "the end ip of the storage network IP range",
- "name": "endip",
- "type": "string"
- },
- {
- "description": "the netmask of the storage network IP range",
- "name": "netmask",
- "type": "string"
- },
- {
"description": "the Zone uuid of the storage network IP range",
"name": "zoneid",
"type": "string"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the network uuid of storage network IP range",
+ "name": "networkid",
"type": "string"
},
+ {},
{
- "description": "the Pod uuid for the storage network IP range",
- "name": "podid",
+ "description": "the gateway of the storage network IP range",
+ "name": "gateway",
"type": "string"
},
{
@@ -81257,32 +82684,41 @@
"type": "string"
},
{
- "description": "the network uuid of storage network IP range",
- "name": "networkid",
+ "description": "the end ip of the storage network IP range",
+ "name": "endip",
"type": "string"
},
{
+ "description": "the ID or VID of the VLAN.",
+ "name": "vlan",
+ "type": "integer"
+ },
+ {
"description": "the start ip of the storage network IP range",
"name": "startip",
"type": "string"
},
{
- "description": "the gateway of the storage network IP range",
- "name": "gateway",
+ "description": "the netmask of the storage network IP range",
+ "name": "netmask",
"type": "string"
},
+ {},
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
- {},
{
- "description": "the ID or VID of the VLAN.",
- "name": "vlan",
- "type": "integer"
+ "description": "the Pod uuid for the storage network IP range",
+ "name": "podid",
+ "type": "string"
},
- {}
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ }
],
"since": "3.0.0"
},
@@ -81292,44 +82728,44 @@
"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,
"name": "id",
"related": "listDomainChildren,listDomains",
"required": true,
"type": "uuid"
+ },
+ {
+ "description": "true if all domain resources (child domains, accounts) have to be cleaned up, false otherwise",
+ "length": 255,
+ "name": "cleanup",
+ "required": false,
+ "type": "boolean"
}
],
"response": [
- {},
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
{
"description": "any text associated 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"
- },
- {}
+ }
]
},
{
@@ -81338,43 +82774,42 @@
"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,
"name": "id",
"related": "configureVirtualRouterElement,listVirtualRouterElements",
"required": true,
"type": "uuid"
+ },
+ {
+ "description": "Enabled/Disabled the service provider",
+ "length": 255,
+ "name": "enabled",
+ "required": true,
+ "type": "boolean"
}
],
"related": "listVirtualRouterElements",
"response": [
{
- "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 project name of the address",
"name": "project",
"type": "string"
},
- {
- "description": "the id of the router",
- "name": "id",
- "type": "string"
- },
{},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the domain associated with the provider",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID associated with the provider",
+ "name": "domainid",
"type": "string"
},
{
@@ -81382,30 +82817,31 @@
"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 domain associated with the provider",
- "name": "domain",
- "type": "string"
- },
- {
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
{
+ "description": "the id of the router",
+ "name": "id",
+ "type": "string"
+ },
+ {
"description": "the project id of the ipaddress",
"name": "projectid",
"type": "string"
+ },
+ {
+ "description": "the physical network service provider id of the provider",
+ "name": "nspid",
+ "type": "string"
}
]
},
@@ -81426,19 +82862,29 @@
"related": "configureHAForHost,disableHAForHost,listHostHAProviders",
"response": [
{
+ "description": "the ID of the host",
+ "name": "hostid",
+ "type": "string"
+ },
+ {
+ "description": "operation status",
+ "name": "status",
+ "type": "boolean"
+ },
+ {
"description": "the HA state of the host",
"name": "hastate",
"type": "hastate"
},
- {},
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
+ {},
{
- "description": "the ID of the host",
- "name": "hostid",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
@@ -81448,19 +82894,9 @@
},
{},
{
- "description": "operation status",
- "name": "status",
- "type": "boolean"
- },
- {
"description": "if host HA is enabled for the host",
"name": "haenable",
"type": "boolean"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
}
],
"since": "4.11"
@@ -81471,13 +82907,6 @@
"name": "migrateVolume",
"params": [
{
- "description": "if the volume should be live migrated when it is attached to a running vm",
- "length": 255,
- "name": "livemigrate",
- "required": false,
- "type": "boolean"
- },
- {
"description": "destination storage pool ID to migrate the volume to",
"length": 255,
"name": "storageid",
@@ -81486,6 +82915,13 @@
"type": "uuid"
},
{
+ "description": "The new disk offering ID that replaces the current one used by the volume. This new disk offering is used to better reflect the new storage where the volume is going to be migrated to.",
+ "length": 255,
+ "name": "newdiskofferingid",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "the ID of the volume",
"length": 255,
"name": "volumeid",
@@ -81494,54 +82930,150 @@
"type": "uuid"
},
{
- "description": "The new disk offering ID that replaces the current one used by the volume. This new disk offering is used to better reflect the new storage where the volume is going to be migrated to.",
+ "description": "if the volume should be live migrated when it is attached to a running vm",
"length": 255,
- "name": "newdiskofferingid",
+ "name": "livemigrate",
"required": false,
- "type": "string"
+ "type": "boolean"
}
],
"related": "createVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume",
"response": [
{
- "description": "the name of the ISO attached to the virtual machine",
- "name": "isoname",
+ "description": "max iops of the disk volume",
+ "name": "maxiops",
+ "type": "long"
+ },
+ {
+ "description": "id of the virtual machine",
+ "name": "virtualmachineid",
"type": "string"
},
{
+ "description": "ID of the availability zone",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "state of the virtual machine",
+ "name": "vmstate",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.",
+ "name": "templateid",
+ "type": "string"
+ },
+ {
+ "description": "the write (bytes) of disk on the vm",
+ "name": "diskkbswrite",
+ "type": "long"
+ },
+ {
+ "description": "name of the disk offering",
+ "name": "diskofferingname",
+ "type": "string"
+ },
+ {
+ "description": "cluster id of the volume",
+ "name": "clusterid",
+ "type": "string"
+ },
+ {
+ "description": "type of the disk volume (ROOT or DATADISK)",
+ "name": "type",
+ "type": "string"
+ },
+ {
+ "description": "provisioning type used to create volumes.",
+ "name": "provisioningtype",
+ "type": "string"
+ },
+ {
+ "description": "ID of the snapshot from which this volume was created",
+ "name": "snapshotid",
+ "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",
"type": "string"
},
{
- "description": "id of the primary storage hosting the disk volume; returned to admin user only",
- "name": "storageid",
+ "description": "the name of the ISO attached to the virtual machine",
+ "name": "isoname",
"type": "string"
},
{
- "description": "the status of the volume",
- "name": "status",
+ "description": "name of the primary storage hosting the disk volume",
+ "name": "storage",
"type": "string"
},
{
- "description": "the bytes actually consumed on disk",
- "name": "virtualsize",
- "type": "long"
- },
- {
- "description": "ID of the service offering for root disk",
- "name": "serviceofferingid",
+ "description": "the state of the disk volume",
+ "name": "state",
"type": "string"
},
{
+ "description": "true if the volume is extractable, false otherwise",
+ "name": "isextractable",
+ "type": "boolean"
+ },
+ {
+ "description": "the name of the template for the virtual machine",
+ "name": "templatename",
+ "type": "string"
+ },
+ {
+ "description": "the boolean state of whether the volume is destroyed or not",
+ "name": "destroyed",
+ "type": "boolean"
+ },
+ {
+ "description": "the ID of the domain associated with the disk volume",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the path of the volume",
+ "name": "path",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the vpn",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "true if storage snapshot is supported for the volume, false otherwise",
+ "name": "supportsstoragesnapshot",
+ "type": "boolean"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "cluster name where the volume is allocated",
+ "name": "clustername",
+ "type": "string"
+ },
+ {},
+ {
"description": "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 volume",
- "name": "id",
- "type": "string"
+ "description": "size of the disk volume",
+ "name": "size",
+ "type": "long"
},
{
"description": "the list of resource tags associated",
@@ -81558,8 +83090,8 @@
"type": "string"
},
{
- "description": "resource type",
- "name": "resourcetype",
+ "description": "tag value",
+ "name": "value",
"type": "string"
},
{
@@ -81568,6 +83100,21 @@
"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 domain associated with the tag",
"name": "domain",
"type": "string"
@@ -81578,202 +83125,56 @@
"type": "string"
},
{
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
"description": "the account associated with the tag",
"name": "account",
"type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
}
],
"type": "set"
},
{
- "description": "the bytes allocated",
- "name": "physicalsize",
- "type": "long"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "size of the disk volume",
- "name": "size",
- "type": "long"
- },
- {
- "description": "the path of the volume",
- "name": "path",
- "type": "string"
- },
- {
- "description": "name of the availability zone",
- "name": "zonename",
- "type": "string"
- },
- {
"description": "name of the service offering for root disk",
"name": "serviceofferingname",
"type": "string"
},
{
- "description": "true if the volume is extractable, false otherwise",
- "name": "isextractable",
- "type": "boolean"
- },
- {
- "description": "the display text of the service offering for root disk",
- "name": "serviceofferingdisplaytext",
- "type": "string"
- },
- {
- "description": "the disk utilization",
- "name": "utilization",
- "type": "string"
- },
- {
- "description": "true if storage snapshot is supported for the volume, false otherwise",
- "name": "supportsstoragesnapshot",
- "type": "boolean"
- },
- {
- "description": "need quiesce vm or not when taking snapshot",
- "name": "quiescevm",
- "type": "boolean"
- },
- {
- "description": "cluster name where the volume is allocated",
- "name": "clustername",
- "type": "string"
- },
- {
- "description": "the project name of the vpn",
- "name": "project",
- "type": "string"
- },
- {
- "description": "bytes write rate of the disk volume",
- "name": "diskBytesWriteRate",
- "type": "long"
- },
- {
- "description": "the write (bytes) of disk on the vm",
- "name": "diskkbswrite",
- "type": "long"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the read (bytes) of disk on the vm",
- "name": "diskkbsread",
- "type": "long"
- },
- {
- "description": "Hypervisor the volume belongs to",
- "name": "hypervisor",
- "type": "string"
- },
- {
- "description": "the chain info of the volume",
- "name": "chaininfo",
- "type": "string"
- },
- {
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "ID of the disk offering",
- "name": "diskofferingid",
- "type": "string"
- },
- {
"description": "the ID of the ISO attached to the virtual machine",
"name": "isoid",
"type": "string"
},
{
- "description": "name of the primary storage hosting the disk volume",
- "name": "storage",
+ "description": "the display text of the disk offering",
+ "name": "diskofferingdisplaytext",
"type": "string"
},
{
- "description": "state of the virtual machine",
- "name": "vmstate",
- "type": "string"
- },
- {
- "description": "shared or local storage",
- "name": "storagetype",
- "type": "string"
- },
- {
- "description": "the domain associated with the disk volume",
- "name": "domain",
- "type": "string"
- },
- {},
- {
- "description": "max iops of the disk volume",
- "name": "maxiops",
+ "description": "the read (bytes) of disk on the vm",
+ "name": "diskkbsread",
"type": "long"
},
{
- "description": "pod name of the volume",
- "name": "podname",
- "type": "string"
- },
- {
- "description": "io requests write rate of the disk volume per the disk offering",
- "name": "diskIopsWriteRate",
- "type": "long"
- },
- {
- "description": "bytes read rate of the disk volume",
- "name": "diskBytesReadRate",
- "type": "long"
- },
- {
- "description": "name of the disk volume",
- "name": "name",
- "type": "string"
- },
- {
- "description": "display name of the virtual machine",
- "name": "vmdisplayname",
- "type": "string"
- },
- {
- "description": "an optional field whether to the display the volume to the end user or not.",
- "name": "displayvolume",
- "type": "boolean"
- },
- {
"description": "the read (io) of disk on the vm",
"name": "diskioread",
"type": "long"
},
{
- "description": "the ID of the domain associated with the disk volume",
- "name": "domainid",
+ "description": "ID of the service offering for root disk",
+ "name": "serviceofferingid",
+ "type": "string"
+ },
+ {
+ "description": "name of the disk volume",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "Hypervisor the volume belongs to",
+ "name": "hypervisor",
+ "type": "string"
+ },
+ {
+ "description": "pod name of the volume",
+ "name": "podname",
"type": "string"
},
{
@@ -81782,83 +83183,48 @@
"type": "string"
},
{
- "description": "provisioning type used to create volumes.",
- "name": "provisioningtype",
+ "description": "ID of the disk offering",
+ "name": "diskofferingid",
"type": "string"
},
{
- "description": "the display text of the disk offering",
- "name": "diskofferingdisplaytext",
+ "description": "the domain associated with the disk volume",
+ "name": "domain",
"type": "string"
},
{
- "description": "pod id of the volume",
- "name": "podid",
- "type": "string"
- },
- {
- "description": "the write (io) of disk on the vm",
- "name": "diskiowrite",
- "type": "long"
- },
- {
- "description": "the account associated with the disk volume",
- "name": "account",
- "type": "string"
- },
- {
- "description": "io requests read rate of the disk volume per the disk offering",
- "name": "diskIopsReadRate",
- "type": "long"
- },
- {
- "description": "the date the disk volume was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "cluster id of the volume",
- "name": "clusterid",
- "type": "string"
- },
- {
- "description": "id of the virtual machine",
- "name": "virtualmachineid",
- "type": "string"
- },
- {
- "description": "name of the disk offering",
- "name": "diskofferingname",
- "type": "string"
- },
- {
- "description": "ID of the snapshot from which this volume was created",
- "name": "snapshotid",
- "type": "string"
- },
- {
- "description": "the boolean state of whether the volume is destroyed or not",
- "name": "destroyed",
- "type": "boolean"
- },
- {
- "description": "min iops of the disk volume",
- "name": "miniops",
- "type": "long"
- },
- {
"description": " an alternate display text of the template for the virtual machine",
"name": "templatedisplaytext",
"type": "string"
},
{
- "description": "an alternate display text of the ISO attached to the virtual machine",
- "name": "isodisplaytext",
+ "description": "the account associated with the disk volume",
+ "name": "account",
"type": "string"
},
{
- "description": "ID of the availability zone",
- "name": "zoneid",
+ "description": "shared or local storage",
+ "name": "storagetype",
+ "type": "string"
+ },
+ {
+ "description": "the chain info of the volume",
+ "name": "chaininfo",
+ "type": "string"
+ },
+ {
+ "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 disk utilization",
+ "name": "utilization",
"type": "string"
},
{
@@ -81867,26 +83233,96 @@
"type": "date"
},
{
- "description": "the state of the disk volume",
- "name": "state",
+ "description": "io requests read rate of the disk volume per the disk offering",
+ "name": "diskIopsReadRate",
+ "type": "long"
+ },
+ {
+ "description": "need quiesce vm or not when taking snapshot",
+ "name": "quiescevm",
+ "type": "boolean"
+ },
+ {
+ "description": "the bytes actually consumed on disk",
+ "name": "virtualsize",
+ "type": "long"
+ },
+ {
+ "description": "the write (io) of disk on the vm",
+ "name": "diskiowrite",
+ "type": "long"
+ },
+ {
+ "description": "bytes read rate of the disk volume",
+ "name": "diskBytesReadRate",
+ "type": "long"
+ },
+ {
+ "description": "min iops of the disk volume",
+ "name": "miniops",
+ "type": "long"
+ },
+ {
+ "description": "the status of the volume",
+ "name": "status",
"type": "string"
},
{
- "description": "type of the disk volume (ROOT or DATADISK)",
- "name": "type",
- "type": "string"
- },
- {},
- {
- "description": "the name of the template for the virtual machine",
- "name": "templatename",
+ "description": "name of the availability zone",
+ "name": "zonename",
"type": "string"
},
{
- "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.",
- "name": "templateid",
+ "description": "an optional field whether to the display the volume to the end user or not.",
+ "name": "displayvolume",
+ "type": "boolean"
+ },
+ {
+ "description": "the display text of the service offering for root disk",
+ "name": "serviceofferingdisplaytext",
"type": "string"
- }
+ },
+ {
+ "description": "bytes write rate of the disk volume",
+ "name": "diskBytesWriteRate",
+ "type": "long"
+ },
+ {
+ "description": "an alternate display text of the ISO attached to the virtual machine",
+ "name": "isodisplaytext",
+ "type": "string"
+ },
+ {
+ "description": "the bytes allocated",
+ "name": "physicalsize",
+ "type": "long"
+ },
+ {
+ "description": "id of the primary storage hosting the disk volume; returned to admin user only",
+ "name": "storageid",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "pod id of the volume",
+ "name": "podid",
+ "type": "string"
+ },
+ {
+ "description": "ID of the disk volume",
+ "name": "id",
+ "type": "string"
+ },
+ {}
],
"since": "3.0.0"
},
@@ -81903,6 +83339,99 @@
"type": "string"
},
{
+ "description": "the ID of the event",
+ "length": 255,
+ "name": "id",
+ "related": "listEvents",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "the start date range of the list you want to retrieve (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\")",
+ "length": 255,
+ "name": "startdate",
+ "required": false,
+ "type": "date"
+ },
+ {
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false",
+ "length": 255,
+ "name": "listall",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "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": "enddate",
+ "required": false,
+ "type": "date"
+ },
+ {
+ "description": "the event level (INFO, WARN, ERROR)",
+ "length": 255,
+ "name": "level",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the duration of the event",
+ "length": 255,
+ "name": "duration",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "the parent/start ID of the event, when provided this will list all the events with the start/parent ID including the parent event",
+ "length": 255,
+ "name": "startid",
+ "related": "listEvents",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "the time the event was entered",
+ "length": 255,
+ "name": "entrytime",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
+ "length": 255,
+ "name": "isrecursive",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "list resources by account. Must be used with the domainId parameter.",
+ "length": 255,
+ "name": "account",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
"description": "list objects by project",
"length": 255,
"name": "projectid",
@@ -81917,146 +83446,16 @@
"related": "listDomainChildren,listDomains",
"required": false,
"type": "uuid"
- },
- {
- "description": "the ID of the event",
- "length": 255,
- "name": "id",
- "related": "listEvents",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "the event level (INFO, WARN, ERROR)",
- "length": 255,
- "name": "level",
- "required": false,
- "type": "string"
- },
- {
- "description": "list resources by account. Must be used with the domainId parameter.",
- "length": 255,
- "name": "account",
- "required": false,
- "type": "string"
- },
- {
- "description": "the 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": "startid",
- "related": "listEvents",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "the duration of the event",
- "length": 255,
- "name": "duration",
- "required": false,
- "type": "integer"
- },
- {
- "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false",
- "length": 255,
- "name": "listall",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
- },
- {
- "description": "",
- "length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
- },
- {
- "description": "the time the event was entered",
- "length": 255,
- "name": "entrytime",
- "required": false,
- "type": "integer"
- },
- {
- "description": "the start date range of the list you want to retrieve (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\")",
- "length": 255,
- "name": "startdate",
- "required": false,
- "type": "date"
- },
- {
- "description": "",
- "length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
- },
- {
- "description": "the end date range of the list you want to retrieve (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\")",
- "length": 255,
- "name": "enddate",
- "required": false,
- "type": "date"
- },
- {
- "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 date the event was created",
- "name": "created",
- "type": "date"
- },
- {},
- {},
- {
- "description": "the name of the account's domain",
- "name": "domain",
- "type": "string"
- },
- {
"description": "the type of the event (see event types)",
"name": "type",
"type": "string"
},
{
- "description": "the id of the account's domain",
- "name": "domainid",
- "type": "string"
- },
- {
- "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 event level (INFO, WARN, ERROR)",
- "name": "level",
- "type": "string"
- },
- {
- "description": "a brief description of the event",
- "name": "description",
- "type": "string"
- },
- {
- "description": "the ID of the event",
- "name": "id",
- "type": "string"
- },
- {
"description": "the state of the event",
"name": "state",
"type": "state"
@@ -82067,13 +83466,49 @@
"type": "string"
},
{
+ "description": "the name of the account's domain",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "a brief description of the event",
+ "name": "description",
+ "type": "string"
+ },
+ {
"description": "the project name of the address",
"name": "project",
"type": "string"
},
{
- "description": "the project id of the ipaddress",
- "name": "projectid",
+ "description": "the id of the account's domain",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the date the event was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "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 event level (INFO, WARN, ERROR)",
+ "name": "level",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the event",
+ "name": "id",
"type": "string"
},
{
@@ -82086,9 +83521,10 @@
"name": "account",
"type": "string"
},
+ {},
{
- "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"
}
]
@@ -82107,17 +83543,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"
@@ -82126,247 +83562,49 @@
"related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance",
"response": [
{
- "description": "the ID of the availablility zone for the virtual machine",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the name of the host for the virtual machine",
- "name": "hostname",
- "type": "string"
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
},
{
"description": "Guest vm Boot Type",
"name": "boottype",
"type": "string"
},
+ {},
+ {
+ "description": "the read (io) of disk on the vm",
+ "name": "diskioread",
+ "type": "long"
+ },
+ {
+ "description": "the incoming network traffic on the vm",
+ "name": "networkkbsread",
+ "type": "long"
+ },
+ {
+ "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 ID of the disk offering of the virtual machine",
+ "name": "diskofferingid",
+ "type": "string"
+ },
{
"description": "the vgpu type used by the virtual machine",
"name": "vgpu",
"type": "string"
},
{
- "description": "the list of resource tags associated",
- "name": "tags",
- "response": [
- {
- "description": "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": "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 project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "Guest vm Boot Mode",
- "name": "bootmode",
- "type": "string"
- },
- {
- "description": "an alternate display text of the ISO attached to the virtual machine",
- "name": "isodisplaytext",
- "type": "string"
- },
- {
- "description": "device ID of the root volume",
- "name": "rootdeviceid",
- "type": "long"
- },
- {
- "description": "the name of the template for the virtual machine",
- "name": "templatename",
- "type": "string"
- },
- {
- "description": "the list of nics associated with vm",
- "name": "nic",
- "response": [
- {
- "description": "the IPv6 address of network",
- "name": "ip6address",
- "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": "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": "the name of the corresponding network",
- "name": "networkname",
- "type": "string"
- },
- {
- "description": "IP addresses associated with NIC found for unmanaged VM",
- "name": "ipaddresses",
- "type": "list"
- },
- {
- "description": "the ID of the corresponding network",
- "name": "networkid",
- "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": "Id of the NSX Logical Switch Port (if NSX based), null otherwise",
- "name": "nsxlogicalswitchport",
- "type": "string"
- },
- {
- "description": "the isolation uri of the nic",
- "name": "isolationuri",
- "type": "string"
- },
- {
- "description": "the ID of the nic",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the isolated private VLAN if available",
- "name": "isolatedpvlan",
- "type": "integer"
- },
- {
- "description": "true if nic is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
- },
- {
- "description": "the extra dhcp options on the nic",
- "name": "extradhcpoption",
- "type": "list"
- },
- {
- "description": "the ip address of the nic",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "description": "Id of the vm to which the nic belongs",
- "name": "virtualmachineid",
- "type": "string"
- },
- {
- "description": "the netmask of the nic",
- "name": "netmask",
- "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 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": "device id for the network when plugged into the virtual machine",
- "name": "deviceid",
- "type": "string"
- },
- {
- "description": "the gateway of IPv6 network",
- "name": "ip6gateway",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": " an alternate display text of the template for the virtual machine",
- "name": "templatedisplaytext",
- "type": "string"
- },
- {
- "description": "the amount of the vm's CPU currently used",
- "name": "cpuused",
+ "description": "the ID of the domain in which the virtual machine exists",
+ "name": "domainid",
"type": "string"
},
{
@@ -82375,28 +83613,73 @@
"type": "string"
},
{
- "description": "the hypervisor on which the template runs",
- "name": "hypervisor",
+ "description": "the name of the host for the virtual machine",
+ "name": "hostname",
"type": "string"
},
{
- "description": "the incoming network traffic on the vm",
- "name": "networkkbsread",
+ "description": "the name of the service offering of the virtual machine",
+ "name": "serviceofferingname",
+ "type": "string"
+ },
+ {
+ "description": "the name of the virtual machine",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": " 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 outgoing network traffic on the host",
+ "name": "networkkbswrite",
"type": "long"
},
{
+ "description": "the read (bytes) of disk on the vm",
+ "name": "diskkbsread",
+ "type": "long"
+ },
+ {
+ "description": "the date when this virtual machine was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
"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": "the ID of the availablility zone for the virtual machine",
+ "name": "zoneid",
+ "type": "string"
},
{
- "description": "the read (io) of disk on the vm",
- "name": "diskioread",
+ "description": "the state of the virtual machine",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "the pool type of the virtual machine",
+ "name": "pooltype",
+ "type": "string"
+ },
+ {
+ "description": "the user's ID who deployed the virtual machine",
+ "name": "userid",
+ "type": "string"
+ },
+ {
+ "description": "the write (io) of disk on the vm",
+ "name": "diskiowrite",
"type": "long"
},
{
@@ -82404,207 +83687,6 @@
"name": "securitygroup",
"response": [
{
- "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 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 project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "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": "resource type",
- "name": "resourcetype",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the project name of the group",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the list of virtualmachine ids associated with this securitygroup",
- "name": "virtualmachineids",
- "type": "set"
- },
- {
- "description": "the list of egress rules associated with the security group",
- "name": "egressrule",
- "response": [
- {
- "description": "account owning the security group rule",
- "name": "account",
- "type": "string"
- },
- {
- "description": "security group name",
- "name": "securitygroupname",
- "type": "string"
- },
- {
- "description": "the 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 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": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "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 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 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 description of the security group",
- "name": "description",
- "type": "string"
- },
- {
- "description": "the project id of the group",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the name of the security group",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the domain name of the security group",
- "name": "domain",
- "type": "string"
- },
- {
"description": "the account owning the security group",
"name": "account",
"type": "string"
@@ -82614,70 +83696,35 @@
"name": "ingressrule",
"response": [
{
+ "description": "the type of the ICMP message response",
+ "name": "icmptype",
+ "type": "integer"
+ },
+ {
+ "description": "the ending IP of the security group rule ",
+ "name": "endport",
+ "type": "integer"
+ },
+ {
"description": "the CIDR notation for the base IP address of the security group rule",
"name": "cidr",
"type": "string"
},
{
- "description": "the starting IP of the security group rule",
- "name": "startport",
- "type": "integer"
- },
- {
- "description": "the code for the ICMP message response",
- "name": "icmpcode",
- "type": "integer"
- },
- {
- "description": "the id of the security group rule",
- "name": "ruleid",
- "type": "string"
- },
- {
- "description": "account owning the security group rule",
- "name": "account",
- "type": "string"
- },
- {
"description": "the list of resource tags associated with the rule",
"name": "tags",
"response": [
{
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
"description": "tag key name",
"name": "key",
"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 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": "the ID of the domain associated with the tag",
"name": "domainid",
"type": "string"
@@ -82688,22 +83735,99 @@
"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",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
"type": "string"
}
],
"type": "set"
},
{
+ "description": "the starting IP of the security group rule",
+ "name": "startport",
+ "type": "integer"
+ },
+ {
"description": "security group name",
"name": "securitygroupname",
"type": "string"
},
{
+ "description": "the 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 protocol of the security group rule",
"name": "protocol",
"type": "string"
+ }
+ ],
+ "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 protocol of the security group rule",
+ "name": "protocol",
+ "type": "string"
+ },
+ {
+ "description": "the CIDR notation for the base IP address of the security group rule",
+ "name": "cidr",
+ "type": "string"
+ },
+ {
+ "description": "account owning the security group rule",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the code for the ICMP message response",
+ "name": "icmpcode",
+ "type": "integer"
},
{
"description": "the type of the ICMP message response",
@@ -82711,9 +83835,81 @@
"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": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the id of the security group rule",
+ "name": "ruleid",
+ "type": "string"
+ },
+ {
"description": "the ending IP of the security group rule ",
"name": "endport",
"type": "integer"
+ },
+ {
+ "description": "the starting IP of the security group rule",
+ "name": "startport",
+ "type": "integer"
+ },
+ {
+ "description": "security group name",
+ "name": "securitygroupname",
+ "type": "string"
}
],
"type": "set"
@@ -82724,26 +83920,108 @@
"type": "string"
},
{
+ "description": "the domain name of the security group",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the list of virtualmachine ids associated with this securitygroup",
+ "name": "virtualmachineids",
+ "type": "set"
+ },
+ {
+ "description": "the domain ID of the security group",
+ "name": "domainid",
+ "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 name of the security group",
+ "name": "name",
+ "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 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": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the description of the security group",
+ "name": "description",
+ "type": "string"
}
],
"type": "set"
},
{
- "description": "OS name of the vm",
- "name": "osdisplayname",
+ "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": "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"
},
{
@@ -82752,189 +84030,13 @@
"type": "string"
},
{
- "description": "the ID of the ISO attached to the virtual machine",
- "name": "isoid",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the user's name who deployed the virtual machine",
- "name": "username",
- "type": "string"
- },
- {
- "description": "public IP address id associated with vm via Static nat rule",
- "name": "publicipid",
- "type": "string"
- },
- {
- "description": "the name of the domain in which the virtual machine exists",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the pool type of the virtual machine",
- "name": "pooltype",
- "type": "string"
- },
- {},
- {
- "description": "Os type ID of the virtual machine",
- "name": "guestosid",
- "type": "string"
- },
- {
- "description": "the memory used by the vm",
- "name": "memorykbs",
- "type": "long"
- },
- {
- "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": "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 account associated with the virtual machine",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the name of the service offering of the virtual machine",
- "name": "serviceofferingname",
- "type": "string"
- },
- {
- "description": "the project id of the vm",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the project name of the vm",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the ID of the service offering of the virtual machine",
- "name": "serviceofferingid",
- "type": "string"
- },
- {
- "description": "the number of cpu this virtual machine is running with",
- "name": "cpunumber",
- "type": "integer"
- },
- {
- "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 read (bytes) of disk on the vm",
- "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 created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the ID of the disk offering of the virtual machine",
- "name": "diskofferingid",
- "type": "string"
- },
- {
- "description": "device type of the root volume",
- "name": "rootdevicetype",
- "type": "string"
- },
- {
- "description": "the user's ID who deployed the virtual machine",
- "name": "userid",
- "type": "string"
- },
- {
- "description": "the ID of the domain in which the virtual machine exists",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the speed of each cpu",
- "name": "cpuspeed",
- "type": "integer"
- },
- {
- "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 memory allocated for the virtual machine",
- "name": "memory",
- "type": "integer"
- },
- {
- "description": "the name of the virtual machine",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the internal memory that's free in vm or zero if it can not be calculated",
- "name": "memoryintfreekbs",
- "type": "long"
- },
- {
- "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.",
- "name": "templateid",
- "type": "string"
- },
- {
- "description": "List of read-only Vm details as comma separated string.",
- "name": "readonlydetails",
- "type": "string"
- },
- {
"description": "list of affinity groups associated with the virtual machine",
"name": "affinitygroup",
"response": [
{
- "description": "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 description of the affinity group",
@@ -82942,13 +84044,18 @@
"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 affinity group",
- "name": "project",
+ "description": "the name of the affinity group",
+ "name": "name",
"type": "string"
},
{
@@ -82957,11 +84064,6 @@
"type": "string"
},
{
- "description": "the ID of the affinity group",
- "name": "id",
- "type": "string"
- },
- {
"description": "the type of the affinity group",
"name": "type",
"type": "string"
@@ -82972,51 +84074,421 @@
"type": "string"
},
{
- "description": "the account owning the affinity group",
- "name": "account",
+ "description": "the project name of the affinity group",
+ "name": "project",
"type": "string"
},
{
- "description": "the name of the affinity group",
- "name": "name",
+ "description": "the account owning the affinity group",
+ "name": "account",
"type": "string"
}
],
"type": "set"
},
{
+ "description": "the memory used by the vm",
+ "name": "memorykbs",
+ "type": "long"
+ },
+ {
+ "description": "the name of the ISO attached to the virtual machine",
+ "name": "isoname",
+ "type": "string"
+ },
+ {
+ "description": "OS name of the vm",
+ "name": "osdisplayname",
+ "type": "string"
+ },
+ {
+ "description": "the project id of the vm",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "Os type ID of the virtual machine",
+ "name": "guestosid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the date when this virtual machine was updated last time",
+ "name": "lastupdated",
+ "type": "date"
+ },
+ {
+ "description": "the memory allocated for the virtual machine",
+ "name": "memory",
+ "type": "integer"
+ },
+ {
+ "description": "the speed of each cpu",
+ "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 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 disk offering of the virtual machine",
+ "name": "diskofferingname",
+ "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": "ssh key-pair",
+ "name": "keypair",
+ "type": "string"
+ },
+ {
+ "description": "the name of the backup offering of the virtual machine",
+ "name": "backupofferingname",
+ "type": "string"
+ },
+ {
+ "description": "List of read-only Vm details as comma separated string.",
+ "name": "readonlydetails",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the virtual machine",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the total number of network traffic bytes sent",
+ "name": "sentbytes",
+ "type": "long"
+ },
+ {
+ "description": "the user's name who deployed the virtual machine",
+ "name": "username",
+ "type": "string"
+ },
+ {
+ "description": "device type of the root volume",
+ "name": "rootdevicetype",
+ "type": "string"
+ },
+ {
+ "description": "the virtual network for the service offering",
+ "name": "forvirtualnetwork",
+ "type": "boolean"
+ },
+ {
"description": "the write (bytes) of disk on the vm",
"name": "diskkbswrite",
"type": "long"
},
{
+ "description": "the group name of the virtual machine",
+ "name": "group",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the vm",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "an alternate display text of the ISO attached to the virtual machine",
+ "name": "isodisplaytext",
+ "type": "string"
+ },
+ {
+ "description": "true if high-availability is enabled, false otherwise",
+ "name": "haenable",
+ "type": "boolean"
+ },
+ {
+ "description": "the list of resource tags associated",
+ "name": "tags",
+ "response": [
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "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": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the ISO attached to the virtual machine",
+ "name": "isoid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the domain in which the virtual machine exists",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the number of cpu this virtual machine is running with",
+ "name": "cpunumber",
+ "type": "integer"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "Guest vm Boot Mode",
+ "name": "bootmode",
+ "type": "string"
+ },
+ {
+ "description": "the name of the template for the virtual machine",
+ "name": "templatename",
+ "type": "string"
+ },
+ {
+ "description": "device ID of the root volume",
+ "name": "rootdeviceid",
+ "type": "long"
+ },
+ {
+ "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 outgoing network traffic on the host",
- "name": "networkkbswrite",
+ "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",
+ "type": "string"
+ },
+ {
+ "description": "Vm details in key/value pairs.",
+ "name": "details",
+ "type": "map"
+ },
+ {
+ "description": "the list of nics associated with vm",
+ "name": "nic",
+ "response": [
+ {
+ "description": "the gateway of the nic",
+ "name": "gateway",
+ "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": "true if nic is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {
+ "description": "the cidr of IPv6 network",
+ "name": "ip6cidr",
+ "type": "string"
+ },
+ {
+ "description": "the gateway of IPv6 network",
+ "name": "ip6gateway",
+ "type": "string"
+ },
+ {
+ "description": "the traffic type of the nic",
+ "name": "traffictype",
+ "type": "string"
+ },
+ {
+ "description": "ID of the VLAN/VNI if available",
+ "name": "vlanid",
+ "type": "integer"
+ },
+ {
+ "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise",
+ "name": "nsxlogicalswitchport",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the corresponding network",
+ "name": "networkid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the corresponding network",
+ "name": "networkname",
+ "type": "string"
+ },
+ {
+ "description": "the type of the nic",
+ "name": "type",
+ "type": "string"
+ },
+ {
+ "description": "the extra dhcp options on the nic",
+ "name": "extradhcpoption",
+ "type": "list"
+ },
+ {
+ "description": "the isolated private VLAN type if available",
+ "name": "isolatedpvlantype",
+ "type": "string"
+ },
+ {
+ "description": "Id of the vm to which the nic belongs",
+ "name": "virtualmachineid",
+ "type": "string"
+ },
+ {
+ "description": "the Secondary ipv4 addr of nic",
+ "name": "secondaryip",
+ "type": "list"
+ },
+ {
+ "description": "Type of adapter if available",
+ "name": "adaptertype",
+ "type": "string"
+ },
+ {
+ "description": "the broadcast uri of the nic",
+ "name": "broadcasturi",
+ "type": "string"
+ },
+ {
+ "description": "the ip address of the nic",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "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 isolated private VLAN if available",
+ "name": "isolatedpvlan",
+ "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": "the isolation uri of the nic",
+ "name": "isolationuri",
+ "type": "string"
+ },
+ {
+ "description": "the IPv6 address of network",
+ "name": "ip6address",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the ID of the service offering of the virtual machine",
+ "name": "serviceofferingid",
+ "type": "string"
+ },
+ {
+ "description": "the internal memory that's free in vm or zero if it can not be calculated",
+ "name": "memoryintfreekbs",
"type": "long"
},
{
- "description": "the virtual network for the service offering",
- "name": "forvirtualnetwork",
- "type": "boolean"
- },
- {
- "description": "the name of the disk offering of the virtual machine",
- "name": "diskofferingname",
- "type": "string"
- },
- {
- "description": "the ID of the host for the virtual machine",
- "name": "hostid",
- "type": "string"
- },
- {
- "description": "the state of the virtual machine",
- "name": "state",
+ "description": "State of the Service from LB rule",
+ "name": "servicestate",
"type": "string"
},
{
@@ -83025,56 +84497,20 @@
"type": "long"
},
{
- "description": "the ID of the backup offering of the virtual machine",
- "name": "backupofferingid",
+ "description": "instance name of the user vm; this parameter is returned to the ROOT admin only",
+ "name": "instancename",
"type": "string"
},
- {
- "description": "the total number of network traffic bytes received",
- "name": "receivedbytes",
- "type": "long"
- },
- {
- "description": "Vm details in key/value pairs.",
- "name": "details",
- "type": "map"
- },
- {
- "description": "the name of the backup offering of the virtual machine",
- "name": "backupofferingname",
- "type": "string"
- },
- {
- "description": "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 name of the ISO attached to the virtual machine",
- "name": "isoname",
+ "description": "the ID of the host for the virtual machine",
+ "name": "hostid",
"type": "string"
},
{
- "description": "the total number of network traffic bytes sent",
- "name": "sentbytes",
- "type": "long"
- },
- {},
- {
- "description": "ssh key-pair",
- "name": "keypair",
+ "description": "the hypervisor on which the template runs",
+ "name": "hypervisor",
"type": "string"
- },
- {
- "description": "true if high-availability is enabled, false otherwise",
- "name": "haenable",
- "type": "boolean"
}
]
},
@@ -83094,17 +84530,6 @@
"related": "configureHAForHost,disableHAForHost",
"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 host HA provider",
"name": "haprovider",
"type": "string"
@@ -83115,6 +84540,12 @@
"type": "string"
},
{},
+ {},
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
{
"description": "if host HA is enabled for the host",
"name": "haenable",
@@ -83126,6 +84557,11 @@
"type": "boolean"
},
{
+ "description": "the ID of the host",
+ "name": "hostid",
+ "type": "string"
+ },
+ {
"description": "the HA state of the host",
"name": "hastate",
"type": "hastate"
@@ -83139,16 +84575,16 @@
"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"
}
@@ -83156,18 +84592,23 @@
"related": "listRegisteredServicePackages",
"response": [
{
- "description": "Description of Service Package",
- "name": "description",
- "type": "string"
- },
- {
"description": "Service Package Name",
"name": "name",
"type": "string"
},
{},
+ {
+ "description": "Service Package UUID",
+ "name": "id",
+ "type": "string"
+ },
{},
{
+ "description": "Description of Service Package",
+ "name": "description",
+ "type": "string"
+ },
+ {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
@@ -83176,11 +84617,6 @@
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
- },
- {
- "description": "Service Package UUID",
- "name": "id",
- "type": "string"
}
]
},
@@ -83197,13 +84633,6 @@
"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,
"name": "resourceids",
@@ -83216,14 +84645,22 @@
"name": "tags",
"required": true,
"type": "map"
+ },
+ {
+ "description": "type of the resource",
+ "length": 255,
+ "name": "resourcetype",
+ "required": true,
+ "type": "string"
}
],
"response": [
{},
+ {},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
{
"description": "any text associated with the success or failure",
@@ -83235,11 +84672,10 @@
"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.0.0"
@@ -83250,36 +84686,31 @@
"name": "configureSrxFirewall",
"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": "SRX firewall device ID",
"length": 255,
"name": "fwdeviceid",
"related": "configureSrxFirewall",
"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": "",
"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 physical network to which this SRX firewall belongs to",
- "name": "physicalnetworkid",
- "type": "string"
- },
- {
- "description": "the public security zone of the external firewall",
- "name": "publiczone",
+ "description": "the timeout (in seconds) for requests to the external firewall",
+ "name": "timeout",
"type": "string"
},
{
@@ -83288,19 +84719,30 @@
"type": "string"
},
{
- "description": "device state",
- "name": "fwdevicestate",
+ "description": "the public security zone of the external firewall",
+ "name": "publiczone",
"type": "string"
},
{
- "description": "the username that's used to log in to the external firewall",
- "name": "username",
+ "description": "the private interface of the external firewall",
+ "name": "privateinterface",
"type": "string"
},
{
- "description": "the 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 zone ID of the external firewall",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the management IP address of the external firewall",
+ "name": "ipaddress",
+ "type": "string"
},
{
"description": "the private security zone of the external firewall",
@@ -83308,28 +84750,8 @@
"type": "string"
},
{
- "description": "device id of the SRX firewall",
- "name": "fwdeviceid",
- "type": "string"
- },
- {
- "description": "device name",
- "name": "fwdevicename",
- "type": "string"
- },
- {
- "description": "device capacity",
- "name": "fwdevicecapacity",
- "type": "long"
- },
- {
- "description": "the timeout (in seconds) for requests to the external firewall",
- "name": "timeout",
- "type": "string"
- },
- {
- "description": "the zone ID of the external firewall",
- "name": "zoneid",
+ "description": "device state",
+ "name": "fwdevicestate",
"type": "string"
},
{
@@ -83338,27 +84760,41 @@
"type": "string"
},
{
- "description": "the private interface of the external firewall",
- "name": "privateinterface",
+ "description": "the physical network to which this SRX firewall belongs to",
+ "name": "physicalnetworkid",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{},
{
- "description": "the number of times to retry requests to the external firewall",
- "name": "numretries",
+ "description": "the username that's used to log in to the external firewall",
+ "name": "username",
"type": "string"
},
{
- "description": "the management IP address of the external firewall",
- "name": "ipaddress",
+ "description": "device capacity",
+ "name": "fwdevicecapacity",
+ "type": "long"
+ },
+ {
+ "description": "device name",
+ "name": "fwdevicename",
+ "type": "string"
+ },
+ {
+ "description": "device id of the SRX firewall",
+ "name": "fwdeviceid",
"type": "string"
},
{
"description": "the public interface of the external firewall",
"name": "publicinterface",
"type": "string"
- },
- {}
+ }
]
},
{
@@ -83378,32 +84814,32 @@
"related": "configureInternalLoadBalancerElement",
"response": [
{
- "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 id of the internal load balancer element",
- "name": "id",
- "type": "string"
+ "description": "Enabled/Disabled the element",
+ "name": "enabled",
+ "type": "boolean"
},
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
+ {
+ "description": "the physical network service provider id of the element",
+ "name": "nspid",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
{},
{
- "description": "Enabled/Disabled the element",
- "name": "enabled",
- "type": "boolean"
- }
+ "description": "the id of the internal load balancer element",
+ "name": "id",
+ "type": "string"
+ },
+ {}
],
"since": "4.2.0"
},
@@ -83422,29 +84858,29 @@
],
"related": "",
"response": [
- {},
{
- "description": "The client certificate",
- "name": "certificate",
+ "description": "The CA certificate(s)",
+ "name": "cacertificates",
"type": "string"
},
{},
{
- "description": "Private key for the certificate",
- "name": "privatekey",
- "type": "string"
- },
- {
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
{
- "description": "The CA certificate(s)",
- "name": "cacertificates",
+ "description": "The client certificate",
+ "name": "certificate",
"type": "string"
},
{
+ "description": "Private key for the certificate",
+ "name": "privatekey",
+ "type": "string"
+ },
+ {},
+ {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
@@ -83468,22 +84904,22 @@
],
"response": [
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {},
- {
"description": "true if operation is executed successfully",
"name": "success",
"type": "boolean"
},
+ {},
{
"description": "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"
@@ -83512,22 +84948,22 @@
"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"
+ },
+ {}
]
},
{
@@ -83536,11 +84972,11 @@
"name": "generateAlert",
"params": [
{
- "description": "Alert description",
- "length": 999,
- "name": "description",
+ "description": "Type of the alert",
+ "length": 255,
+ "name": "type",
"required": true,
- "type": "string"
+ "type": "short"
},
{
"description": "Zone id for which alert is generated",
@@ -83566,31 +85002,31 @@
"type": "string"
},
{
- "description": "Type of the alert",
- "length": 255,
- "name": "type",
+ "description": "Alert description",
+ "length": 999,
+ "name": "description",
"required": true,
- "type": "short"
+ "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": "the UUID 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",
@@ -83612,6 +85048,14 @@
"type": "string"
},
{
+ "description": "ID of the Project role",
+ "length": 255,
+ "name": "id",
+ "related": "updateProjectRole",
+ "required": true,
+ "type": "uuid"
+ },
+ {
"description": "creates a project role with this unique name",
"length": 255,
"name": "name",
@@ -83625,50 +85069,42 @@
"related": "activateProject,suspendProject",
"required": true,
"type": "uuid"
- },
- {
- "description": "ID of the Project role",
- "length": 255,
- "name": "id",
- "related": "updateProjectRole",
- "required": true,
- "type": "uuid"
}
],
"related": "",
"response": [
+ {},
+ {
+ "description": "the description of the role",
+ "name": "description",
+ "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": "the name of the role",
- "name": "name",
- "type": "string"
- },
- {},
- {
- "description": "the description of the role",
- "name": "description",
- "type": "string"
- },
- {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
{
- "description": "the id of the project",
- "name": "projectid",
+ "description": "the name of the role",
+ "name": "name",
"type": "string"
- },
- {}
+ }
],
"since": "4.15.0"
},
@@ -83685,48 +85121,48 @@
"type": "string"
},
{
+ "description": "Port",
+ "length": 255,
+ "name": "port",
+ "required": true,
+ "type": "integer"
+ },
+ {
"description": "linked domain",
"length": 255,
"name": "domainid",
"related": "listDomainChildren,listDomains",
"required": false,
"type": "uuid"
- },
- {
- "description": "Port",
- "length": 255,
- "name": "port",
- "required": true,
- "type": "integer"
}
],
"related": "",
"response": [
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
- {},
{
"description": "port teh 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 current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
{},
{
- "description": "name of the host running the ldap server",
- "name": "hostname",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
}
],
@@ -83738,6 +85174,20 @@
"name": "ldapConfig",
"params": [
{
+ "description": "Specify the LDAP port if required, default is 389.",
+ "length": 255,
+ "name": "port",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "Hostname or ip address of the ldap server eg: my.ldap.com",
+ "length": 255,
+ "name": "hostname",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "Specify the distinguished name of a user with the search permission on the directory.",
"length": 255,
"name": "binddn",
@@ -83745,41 +85195,6 @@
"type": "string"
},
{
- "description": "If true return current LDAP configuration",
- "length": 255,
- "name": "listall",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "Enter the password.",
- "length": 255,
- "name": "bindpass",
- "required": false,
- "type": "string"
- },
- {
- "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL.",
- "length": 255,
- "name": "ssl",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "Enter the password for trust store.",
- "length": 255,
- "name": "truststorepass",
- "required": false,
- "type": "string"
- },
- {
- "description": "Enter the path to trust certificates store.",
- "length": 255,
- "name": "truststore",
- "required": false,
- "type": "string"
- },
- {
"description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com.",
"length": 255,
"name": "searchbase",
@@ -83787,13 +85202,6 @@
"type": "string"
},
{
- "description": "Hostname or ip address of the ldap server eg: my.ldap.com",
- "length": 255,
- "name": "hostname",
- "required": false,
- "type": "string"
- },
- {
"description": "You specify a query filter here, which narrows down the users, who can be part of this domain.",
"length": 255,
"name": "queryfilter",
@@ -83801,21 +85209,44 @@
"type": "string"
},
{
- "description": "Specify the LDAP port if required, default is 389.",
+ "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL.",
"length": 255,
- "name": "port",
+ "name": "ssl",
"required": false,
- "type": "integer"
+ "type": "boolean"
+ },
+ {
+ "description": "Enter the path to trust certificates store.",
+ "length": 255,
+ "name": "truststore",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "Enter the password.",
+ "length": 255,
+ "name": "bindpass",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "If true return current LDAP configuration",
+ "length": 255,
+ "name": "listall",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "Enter the password for trust store.",
+ "length": 255,
+ "name": "truststorepass",
+ "required": false,
+ "type": "string"
}
],
"related": "ldapRemove",
"response": [
{
- "description": "Specify the distinguished name of a user with the search permission on the directory",
- "name": "binddn",
- "type": "string"
- },
- {
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
@@ -83825,23 +85256,28 @@
"name": "queryfilter",
"type": "string"
},
- {},
- {
- "description": "Hostname or ip address of the ldap server eg: my.ldap.com",
- "name": "hostname",
- "type": "string"
- },
{
"description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL",
"name": "ssl",
"type": "string"
},
+ {},
+ {},
+ {
+ "description": "Specify the distinguished name of a user with the search permission on the directory",
+ "name": "binddn",
+ "type": "string"
+ },
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
- {},
+ {
+ "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com",
+ "name": "searchbase",
+ "type": "string"
+ },
{
"description": "Specify the LDAP port if required, default is 389",
"name": "port",
@@ -83853,8 +85289,8 @@
"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": "Hostname or ip address of the ldap server eg: my.ldap.com",
+ "name": "hostname",
"type": "string"
}
],
@@ -83877,25 +85313,17 @@
"related": "",
"response": [
{
- "description": "the ID of the Zone",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the description of the Storage Policy",
- "name": "description",
- "type": "string"
- },
- {
"description": "the name of the Storage Policy",
"name": "name",
"type": "string"
},
+ {},
{
- "description": "the ID of the Storage Policy",
- "name": "id",
+ "description": "the ID of the Zone",
+ "name": "zoneid",
"type": "string"
},
+ {},
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
@@ -83907,12 +85335,20 @@
"type": "string"
},
{
+ "description": "the ID of the Storage Policy",
+ "name": "id",
+ "type": "string"
+ },
+ {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
- {},
- {}
+ {
+ "description": "the description of the Storage Policy",
+ "name": "description",
+ "type": "string"
+ }
]
},
{
@@ -83931,6 +85367,7 @@
],
"response": [
{},
+ {},
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
@@ -83941,16 +85378,15 @@
"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"
}
]
},
@@ -83960,6 +85396,13 @@
"name": "migrateVPC",
"params": [
{
+ "description": "true if previous network migration cmd failed",
+ "length": 255,
+ "name": "resume",
+ "required": false,
+ "type": "boolean"
+ },
+ {
"description": "network offering ids for each network in the vpc. Example: tierNetworkOfferings[0].networkId=networkId1&tierNetworkOfferings[0].networkOfferingId=newNetworkofferingId1&tierNetworkOfferings[1].networkId=networkId2&tierNetworkOfferings[1].networkOfferingId=newNetworkofferingId2",
"length": 255,
"name": "tiernetworkofferings",
@@ -83975,13 +85418,6 @@
"type": "uuid"
},
{
- "description": "true if previous network migration cmd failed",
- "length": 255,
- "name": "resume",
- "required": false,
- "type": "boolean"
- },
- {
"description": "vpc offering ID",
"length": 255,
"name": "vpcofferingid",
@@ -83993,38 +85429,81 @@
"related": "createVPC,listVPCs,updateVPC",
"response": [
{
- "description": "the date this VPC was created",
- "name": "created",
- "type": "date"
+ "description": "the list of resource tags associated with the project",
+ "name": "tags",
+ "response": [
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ }
+ ],
+ "type": "list"
},
{
- "description": "is vpc for display to the regular user",
- "name": "fordisplay",
- "type": "boolean"
+ "description": "zone id of the vpc",
+ "name": "zoneid",
+ "type": "string"
},
{
"description": "true if VPC is region level",
"name": "regionlevelvpc",
"type": "boolean"
},
+ {},
{
- "description": "the name of the VPC",
- "name": "name",
- "type": "string"
+ "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's",
+ "name": "distributedvpcrouter",
+ "type": "boolean"
},
{
- "description": "state of the VPC. Can be Inactive/Enabled",
- "name": "state",
- "type": "string"
- },
- {
- "description": "the list of networks belongign to the VPC",
- "name": "network",
- "type": "list"
- },
- {
- "description": "the domain name of the owner",
- "name": "domain",
+ "description": "the name of the zone the VPC belongs to",
+ "name": "zonename",
"type": "string"
},
{
@@ -84033,20 +85512,70 @@
"type": "string"
},
{
+ "description": "true VPC requires restart",
+ "name": "restartrequired",
+ "type": "boolean"
+ },
+ {
+ "description": "the domain id of the VPC owner",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
"description": "Base64 string representation of the resource icon",
"name": "icon",
"type": "resourceiconresponse"
},
{
- "description": "if this VPC has redundant router",
- "name": "redundantvpcrouter",
+ "description": "the network domain of the VPC",
+ "name": "networkdomain",
+ "type": "string"
+ },
+ {
+ "description": "vpc offering id the VPC is created from",
+ "name": "vpcofferingid",
+ "type": "string"
+ },
+ {
+ "description": "the date this VPC was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "state of the VPC. Can be Inactive/Enabled",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "vpc offering name the VPC is created from",
+ "name": "vpcofferingname",
+ "type": "string"
+ },
+ {
+ "description": "the domain name of the owner",
+ "name": "domain",
+ "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": "the list of supported services",
"name": "service",
"response": [
{
+ "description": "the service name",
+ "name": "name",
+ "type": "string"
+ },
+ {
"description": "the list of capabilities",
"name": "capability",
"response": [
@@ -84069,15 +85598,30 @@
"type": "list"
},
{
- "description": "the service name",
- "name": "name",
- "type": "string"
- },
- {
"description": "the service provider name",
"name": "provider",
"response": [
{
+ "description": "the provider name",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "true if individual services can be enabled/disabled",
+ "name": "canenableindividualservice",
+ "type": "boolean"
+ },
+ {
+ "description": "the destination physical network",
+ "name": "destinationphysicalnetworkid",
+ "type": "string"
+ },
+ {
+ "description": "services for this provider",
+ "name": "servicelist",
+ "type": "list"
+ },
+ {
"description": "state of the network provider",
"name": "state",
"type": "string"
@@ -84088,26 +85632,6 @@
"type": "string"
},
{
- "description": "the destination physical network",
- "name": "destinationphysicalnetworkid",
- "type": "string"
- },
- {
- "description": "true if individual services can be enabled/disabled",
- "name": "canenableindividualservice",
- "type": "boolean"
- },
- {
- "description": "the provider name",
- "name": "name",
- "type": "string"
- },
- {
- "description": "services for this provider",
- "name": "servicelist",
- "type": "list"
- },
- {
"description": "uuid of the network provider",
"name": "id",
"type": "string"
@@ -84119,113 +85643,29 @@
"type": "list"
},
{
- "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's",
- "name": "distributedvpcrouter",
- "type": "boolean"
- },
- {
- "description": "vpc offering name the VPC is created from",
- "name": "vpcofferingname",
- "type": "string"
- },
- {},
- {
- "description": "zone id of the vpc",
- "name": "zoneid",
- "type": "string"
- },
- {
"description": "the cidr the VPC",
"name": "cidr",
"type": "string"
},
- {},
- {
- "description": "vpc offering id the VPC is created from",
- "name": "vpcofferingid",
- "type": "string"
- },
- {
- "description": "the domain id of the VPC owner",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
{
"description": "an alternate display text of the VPC.",
"name": "displaytext",
"type": "string"
},
{
+ "description": "the name of the VPC",
+ "name": "name",
+ "type": "string"
+ },
+ {
"description": "the id of the VPC",
"name": "id",
"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",
- "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": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- }
- ],
- "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",
@@ -84233,29 +85673,25 @@
"type": "string"
},
{
- "description": "the network domain of the VPC",
- "name": "networkdomain",
- "type": "string"
- },
- {
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
+ "description": "if this VPC has redundant router",
+ "name": "redundantvpcrouter",
"type": "boolean"
},
{
- "description": "the project id of the VPC",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the name of the zone the VPC belongs to",
- "name": "zonename",
- "type": "string"
- },
- {
"description": "the owner of the VPC",
"name": "account",
"type": "string"
+ },
+ {
+ "description": "is vpc for display to the regular user",
+ "name": "fordisplay",
+ "type": "boolean"
+ },
+ {},
+ {
+ "description": "the project id of the VPC",
+ "name": "projectid",
+ "type": "string"
}
],
"since": "4.11.0"
@@ -84275,27 +85711,27 @@
}
],
"response": [
- {},
{
"description": "true if operation is executed successfully",
"name": "success",
"type": "boolean"
},
{
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
"description": "any text associated with the success or failure",
"name": "displaytext",
"type": "string"
},
{},
+ {},
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
}
]
},
@@ -84321,52 +85757,12 @@
],
"related": "removeAnnotation",
"response": [
- {
- "description": "The username of the user that entered the annotation",
- "name": "username",
- "type": "string"
- },
- {
- "description": "the (uu)id of the entitiy to which this annotation pertains",
- "name": "entityid",
- "type": "string"
- },
- {
- "description": "The (uu)id of the user that entered the annotation",
- "name": "userid",
- "type": "string"
- },
{},
{
- "description": "the removal timestamp for this annotation",
- "name": "removed",
- "type": "date"
- },
- {
- "description": "the name of the entitiy to which this annotation pertains",
- "name": "entityname",
- "type": "string"
- },
- {
"description": "the creation timestamp for this annotation",
"name": "created",
"type": "date"
},
- {
- "description": "the (uu)id of the annotation",
- "name": "id",
- "type": "string"
- },
- {
- "description": "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 contents of the annotation",
@@ -84374,14 +85770,54 @@
"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 annotation",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the name of the entitiy to which this annotation pertains",
+ "name": "entityname",
+ "type": "string"
+ },
+ {
+ "description": "the (uu)id of the entitiy to which this annotation pertains",
+ "name": "entityid",
+ "type": "string"
+ },
+ {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
{
+ "description": "True if the annotation is available for admins only",
+ "name": "adminsonly",
+ "type": "boolean"
+ },
+ {
"description": "the type of the annotated entity",
"name": "entitytype",
"type": "string"
+ },
+ {
+ "description": "The (uu)id of the user that entered the annotation",
+ "name": "userid",
+ "type": "string"
+ },
+ {
+ "description": "The username of the user that entered the annotation",
+ "name": "username",
+ "type": "string"
+ },
+ {
+ "description": "the removal timestamp for this annotation",
+ "name": "removed",
+ "type": "date"
}
],
"since": "4.16"
@@ -84392,11 +85828,18 @@
"name": "listBigSwitchBcfDevices",
"params": [
{
- "description": "List by keyword",
+ "description": "",
"length": 255,
- "name": "keyword",
+ "name": "pagesize",
"required": false,
- "type": "string"
+ "type": "integer"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
},
{
"description": "the Physical Network ID",
@@ -84415,23 +85858,58 @@
"type": "uuid"
},
{
- "description": "",
+ "description": "List by keyword",
"length": 255,
- "name": "pagesize",
+ "name": "keyword",
"required": false,
- "type": "integer"
- },
- {
- "description": "",
- "length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
+ "type": "string"
}
],
"related": "",
"response": [
{
+ "description": "device name",
+ "name": "bigswitchdevicename",
+ "type": "string"
+ },
+ {
+ "description": "device id of the BigSwitch BCF Controller",
+ "name": "bcfdeviceid",
+ "type": "string"
+ },
+ {
+ "description": "the controller username",
+ "name": "username",
+ "type": "string"
+ },
+ {},
+ {
+ "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",
+ "type": "string"
+ },
+ {
+ "description": "name of the provider",
+ "name": "provider",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the controller password",
+ "name": "password",
+ "type": "string"
+ },
+ {
"description": "the controller Ip address",
"name": "hostname",
"type": "string"
@@ -84440,48 +85918,6 @@
"description": "NAT support",
"name": "nat",
"type": "boolean"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {},
- {
- "description": "the controller password",
- "name": "password",
- "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": "device name",
- "name": "bigswitchdevicename",
- "type": "string"
- },
- {
- "description": "the controller username",
- "name": "username",
- "type": "string"
- },
- {
- "description": "device id of the BigSwitch BCF Controller",
- "name": "bcfdeviceid",
- "type": "string"
- },
- {},
- {
- "description": "the physical network to which this BigSwitch BCF segment belongs to",
- "name": "physicalnetworkid",
- "type": "string"
}
],
"since": "4.6.0"
@@ -84499,6 +85935,14 @@
"type": "string"
},
{
+ "description": "the ID of the Image Store to update the parameter value for corresponding image store",
+ "length": 255,
+ "name": "imagestoreuuid",
+ "related": "listSwifts,addImageStoreS3,listImageStores",
+ "required": false,
+ "type": "uuid"
+ },
+ {
"description": "the ID of the Zone to update the parameter value for corresponding zone",
"length": 255,
"name": "zoneid",
@@ -84507,6 +85951,14 @@
"type": "uuid"
},
{
+ "description": "the ID of the Cluster to update the parameter value for corresponding cluster",
+ "length": 255,
+ "name": "clusterid",
+ "related": "addCluster",
+ "required": false,
+ "type": "uuid"
+ },
+ {
"description": "the ID of the Domain to update the parameter value for corresponding domain",
"length": 255,
"name": "domainid",
@@ -84523,13 +85975,6 @@
"type": "uuid"
},
{
- "description": "the value of the configuration",
- "length": 4095,
- "name": "value",
- "required": false,
- "type": "string"
- },
- {
"description": "the ID of the Account to update the parameter value for corresponding account",
"length": 255,
"name": "accountid",
@@ -84538,42 +85983,17 @@
"type": "uuid"
},
{
- "description": "the ID of the Image Store to update the parameter value for corresponding image store",
- "length": 255,
- "name": "imagestoreuuid",
- "related": "listSwifts,addImageStoreS3,listImageStores",
+ "description": "the value of the configuration",
+ "length": 4095,
+ "name": "value",
"required": false,
- "type": "uuid"
- },
- {
- "description": "the ID of the Cluster to update the parameter value for corresponding cluster",
- "length": 255,
- "name": "clusterid",
- "related": "addCluster",
- "required": false,
- "type": "uuid"
+ "type": "string"
}
],
"related": "",
"response": [
{
"description": "the value of the configuration",
- "name": "id",
- "type": "long"
- },
- {
- "description": "the description of the configuration",
- "name": "description",
- "type": "string"
- },
- {
- "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated",
- "name": "scope",
- "type": "string"
- },
- {},
- {
- "description": "the value of the configuration",
"name": "value",
"type": "string"
},
@@ -84583,11 +86003,33 @@
"type": "string"
},
{
+ "description": "the value of the configuration",
+ "name": "id",
+ "type": "long"
+ },
+ {
+ "description": "the description of the configuration",
+ "name": "description",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {},
+ {
"description": "the category of the configuration",
"name": "category",
"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"
@@ -84596,12 +86038,6 @@
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
- },
- {},
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
}
]
},
@@ -84611,37 +86047,32 @@
"name": "configureHAForHost",
"params": [
{
- "description": "HA provider",
- "length": 255,
- "name": "provider",
- "required": true,
- "type": "string"
- },
- {
"description": "ID of the host",
"length": 255,
"name": "hostid",
"related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost",
"required": true,
"type": "uuid"
+ },
+ {
+ "description": "HA provider",
+ "length": 255,
+ "name": "provider",
+ "required": true,
+ "type": "string"
}
],
"related": "disableHAForHost",
"response": [
{
- "description": "if host HA is enabled for the host",
- "name": "haenable",
- "type": "boolean"
+ "description": "the HA state of the host",
+ "name": "hastate",
+ "type": "hastate"
},
{
- "description": "the ID of the host",
- "name": "hostid",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
{
"description": "the host HA provider",
@@ -84655,16 +86086,21 @@
"type": "boolean"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "if host HA is enabled for the host",
+ "name": "haenable",
+ "type": "boolean"
+ },
+ {},
+ {
+ "description": "the ID of the host",
+ "name": "hostid",
+ "type": "string"
},
{
- "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"
+ }
],
"since": "4.11"
},
@@ -84674,18 +86110,11 @@
"name": "dedicatePublicIpRange",
"params": [
{
- "description": "account who will own the VLAN",
+ "description": "project who will own the VLAN",
"length": 255,
- "name": "account",
+ "name": "projectid",
+ "related": "activateProject,suspendProject",
"required": false,
- "type": "string"
- },
- {
- "description": "the id of the VLAN IP range",
- "length": 255,
- "name": "id",
- "related": "dedicatePublicIpRange",
- "required": true,
"type": "uuid"
},
{
@@ -84697,55 +86126,31 @@
"type": "uuid"
},
{
- "description": "project who will own the VLAN",
+ "description": "the id of the VLAN IP range",
"length": 255,
- "name": "projectid",
- "related": "activateProject,suspendProject",
- "required": false,
+ "name": "id",
+ "related": "dedicatePublicIpRange",
+ "required": true,
"type": "uuid"
+ },
+ {
+ "description": "account who will own the VLAN",
+ "length": 255,
+ "name": "account",
+ "required": false,
+ "type": "string"
}
],
"related": "",
"response": [
- {},
- {
- "description": "the description of the VLAN IP range",
- "name": "description",
- "type": "string"
- },
- {
- "description": "the end ip of the VLAN IP range",
- "name": "endip",
- "type": "string"
- },
- {
- "description": "the physical network this belongs to",
- "name": "physicalnetworkid",
- "type": "string"
- },
- {
- "description": "the gateway of the VLAN IP range",
- "name": "gateway",
- "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 netmask of the VLAN IP range",
"name": "netmask",
"type": "string"
},
{
- "description": "the project id of the vlan range",
- "name": "projectid",
+ "description": "the description of the VLAN IP range",
+ "name": "description",
"type": "string"
},
{
@@ -84754,49 +86159,23 @@
"type": "string"
},
{
- "description": "the network id of vlan range",
- "name": "networkid",
+ "description": "the cidr of IPv6 network",
+ "name": "ip6cidr",
"type": "string"
},
{
- "description": "the ID or VID of the VLAN.",
- "name": "vlan",
+ "description": "the physical network this belongs to",
+ "name": "physicalnetworkid",
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {},
- {
- "description": "the account of the VLAN IP range",
- "name": "account",
+ "description": "the Pod ID for the VLAN IP range",
+ "name": "podid",
"type": "string"
},
{
- "description": "the project name of the vlan range",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the virtual network for the VLAN IP range",
- "name": "forvirtualnetwork",
- "type": "boolean"
- },
- {
- "description": "the Pod name for the VLAN IP range",
- "name": "podname",
- "type": "string"
- },
- {
- "description": "the end ipv6 of the VLAN IP range",
- "name": "endipv6",
- "type": "string"
- },
- {
- "description": "the domain ID of the VLAN IP range",
- "name": "domainid",
+ "description": "the project id of the vlan range",
+ "name": "projectid",
"type": "string"
},
{
@@ -84810,29 +86189,86 @@
"type": "string"
},
{
- "description": "the domain name of the VLAN IP range",
- "name": "domain",
+ "description": "the start ip of the VLAN IP range",
+ "name": "startip",
"type": "string"
},
{
- "description": "the Pod ID for the VLAN IP range",
- "name": "podid",
+ "description": "the end ipv6 of the VLAN IP range",
+ "name": "endipv6",
"type": "string"
},
{
- "description": "indicates whether VLAN IP range is dedicated to system vms or not",
- "name": "forsystemvms",
+ "description": "the project name of the vlan range",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the virtual network for the VLAN IP range",
+ "name": "forvirtualnetwork",
"type": "boolean"
},
{
+ "description": "the account of the VLAN IP range",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the gateway of the VLAN IP range",
+ "name": "gateway",
+ "type": "string"
+ },
+ {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
{
+ "description": "the domain ID of the VLAN IP range",
+ "name": "domainid",
+ "type": "string"
+ },
+ {},
+ {},
+ {
+ "description": "the network id of vlan range",
+ "name": "networkid",
+ "type": "string"
+ },
+ {
+ "description": "the Pod name for the VLAN IP range",
+ "name": "podname",
+ "type": "string"
+ },
+ {
"description": "the gateway of IPv6 network",
"name": "ip6gateway",
"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 VLAN IP range",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the end ip of the VLAN IP range",
+ "name": "endip",
+ "type": "string"
+ },
+ {
+ "description": "the ID or VID of the VLAN.",
+ "name": "vlan",
+ "type": "string"
+ },
+ {
+ "description": "indicates whether VLAN IP range is dedicated to system vms or not",
+ "name": "forsystemvms",
+ "type": "boolean"
}
]
},
@@ -84842,6 +86278,13 @@
"name": "createProjectRolePermission",
"params": [
{
+ "description": "The rule permission, allow or deny. Default: deny.",
+ "length": 255,
+ "name": "permission",
+ "required": true,
+ "type": "string"
+ },
+ {
"description": "The API name or wildcard rule such as list*",
"length": 255,
"name": "rule",
@@ -84849,11 +86292,12 @@
"type": "string"
},
{
- "description": "The rule permission, allow or deny. Default: deny.",
+ "description": "ID of project where project role permission is to be created",
"length": 255,
- "name": "permission",
+ "name": "projectid",
+ "related": "activateProject,suspendProject",
"required": true,
- "type": "string"
+ "type": "uuid"
},
{
"description": "The description of the role permission",
@@ -84869,37 +86313,18 @@
"related": "",
"required": true,
"type": "uuid"
- },
- {
- "description": "ID of project where project role permission is to be created",
- "length": 255,
- "name": "projectid",
- "related": "activateProject,suspendProject",
- "required": true,
- "type": "uuid"
}
],
"related": "",
"response": [
- {},
{
"description": "the description of the role permission",
"name": "description",
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the ID of the project",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the permission type of the api name or wildcard rule, allow/deny",
- "name": "permission",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
@@ -84908,8 +86333,8 @@
"type": "string"
},
{
- "description": "the name of the project role to which the role permission belongs",
- "name": "projectrolename",
+ "description": "the ID of the project role permission",
+ "name": "id",
"type": "string"
},
{},
@@ -84919,14 +86344,25 @@
"type": "string"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the ID of the project",
+ "name": "projectid",
"type": "string"
},
{
- "description": "the ID of the project role permission",
- "name": "id",
+ "description": "the name of the project role to which the role permission belongs",
+ "name": "projectrolename",
"type": "string"
+ },
+ {},
+ {
+ "description": "the permission type of the api name or wildcard rule, allow/deny",
+ "name": "permission",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
}
],
"since": "4.15.0"
@@ -84944,48 +86380,48 @@
"type": "integer"
},
{
- "description": "",
- "length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
- },
- {
"description": "List by keyword",
"length": 255,
"name": "keyword",
"required": false,
"type": "string"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
}
],
"related": "",
"response": [
{
- "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": "Description of Service Package",
"name": "description",
"type": "string"
},
{
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
"description": "Service Package Name",
"name": "name",
"type": "string"
},
+ {},
+ {},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "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"
}
]
},
@@ -84995,20 +86431,11 @@
"name": "updateProjectRolePermission",
"params": [
{
- "description": "The parent role permission uuid, use 0 to move this rule at the top of the list",
+ "description": "Rule permission, can be: allow or deny",
"length": 255,
- "name": "ruleorder",
- "related": "",
+ "name": "permission",
"required": false,
- "type": "list"
- },
- {
- "description": "ID of project where project role permission is to be updated",
- "length": 255,
- "name": "projectid",
- "related": "activateProject,suspendProject",
- "required": true,
- "type": "uuid"
+ "type": "string"
},
{
"description": "Project Role permission rule id",
@@ -85019,23 +86446,37 @@
"type": "uuid"
},
{
+ "description": "ID of project where project role permission is to be updated",
+ "length": 255,
+ "name": "projectid",
+ "related": "activateProject,suspendProject",
+ "required": true,
+ "type": "uuid"
+ },
+ {
+ "description": "The parent role permission uuid, use 0 to move this rule at the top of the list",
+ "length": 255,
+ "name": "ruleorder",
+ "related": "",
+ "required": false,
+ "type": "list"
+ },
+ {
"description": "ID of the project role",
"length": 255,
"name": "projectroleid",
"related": "",
"required": true,
"type": "uuid"
- },
- {
- "description": "Rule permission, can be: allow or deny",
- "length": 255,
- "name": "permission",
- "required": false,
- "type": "string"
}
],
"response": [
{},
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
{},
{
"description": "the UUID of the latest async job acting on this object",
@@ -85043,11 +86484,6 @@
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
"description": "true if operation is executed successfully",
"name": "success",
"type": "boolean"
@@ -85066,6 +86502,14 @@
"name": "enableStaticNat",
"params": [
{
+ "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": "networkid",
+ "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listBrocadeVcsDeviceNetworks",
+ "required": false,
+ "type": "uuid"
+ },
+ {
"description": "VM guest NIC secondary IP address for the port forwarding rule",
"length": 255,
"name": "vmguestip",
@@ -85073,11 +86517,11 @@
"type": "string"
},
{
- "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": "the public IP address ID for which static NAT feature is being enabled",
"length": 255,
- "name": "networkid",
- "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listBrocadeVcsDeviceNetworks",
- "required": false,
+ "name": "ipaddressid",
+ "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses",
+ "required": true,
"type": "uuid"
},
{
@@ -85087,26 +86531,14 @@
"related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance",
"required": true,
"type": "uuid"
- },
- {
- "description": "the public IP address ID for which static NAT feature is being enabled",
- "length": 255,
- "name": "ipaddressid",
- "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses",
- "required": true,
- "type": "uuid"
}
],
"response": [
+ {},
{
- "description": "any text associated with the success or failure",
- "name": "displaytext",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
{
"description": "true if operation is executed successfully",
@@ -85114,12 +86546,16 @@
"type": "boolean"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "any text associated with the success or failure",
+ "name": "displaytext",
+ "type": "string"
},
{},
- {}
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ }
]
},
{
@@ -85138,26 +86574,26 @@
],
"response": [
{
- "description": "true if operation is executed successfully",
- "name": "success",
- "type": "boolean"
+ "description": "any text associated with the success or failure",
+ "name": "displaytext",
+ "type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {},
- {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
{
- "description": "any text associated 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"
+ },
+ {},
{}
]
},
@@ -85167,21 +86603,6 @@
"name": "addUserToProject",
"params": [
{
- "description": "ID of the project to add the user to",
- "length": 255,
- "name": "projectid",
- "related": "activateProject,suspendProject",
- "required": true,
- "type": "uuid"
- },
- {
- "description": "Project role type to be assigned to the user - Admin/Regular",
- "length": 255,
- "name": "roletype",
- "required": false,
- "type": "string"
- },
- {
"description": "Name of the user to be added to the project",
"length": 255,
"name": "username",
@@ -85196,6 +86617,21 @@
"type": "string"
},
{
+ "description": "Project role type to be assigned to the user - Admin/Regular",
+ "length": 255,
+ "name": "roletype",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "ID of the project to add the user to",
+ "length": 255,
+ "name": "projectid",
+ "related": "activateProject,suspendProject",
+ "required": true,
+ "type": "uuid"
+ },
+ {
"description": "ID of the project role",
"length": 255,
"name": "projectroleid",
@@ -85205,27 +86641,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": "any text associated with the success or failure",
+ "name": "displaytext",
+ "type": "string"
}
],
"since": "4.14"
@@ -85256,17 +86692,17 @@
"name": "jobid",
"type": "string"
},
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
+ {},
{
"description": "true if operation is executed successfully",
"name": "success",
"type": "boolean"
},
- {}
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ }
],
"since": "4.11"
},
@@ -85287,62 +86723,149 @@
"related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance",
"response": [
{
- "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.",
- "name": "isdynamicallyscalable",
+ "description": "the internal memory that's free in vm or zero if it can not be calculated",
+ "name": "memoryintfreekbs",
+ "type": "long"
+ },
+ {
+ "description": "the name of the backup offering of the virtual machine",
+ "name": "backupofferingname",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the virtual machine",
+ "name": "account",
+ "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 domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "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": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "ssh key-pair",
+ "name": "keypair",
+ "type": "string"
+ },
+ {
+ "description": "the read (io) of disk on the vm",
+ "name": "diskioread",
+ "type": "long"
+ },
+ {
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "description": "public IP address id associated with vm via Static nat rule",
+ "name": "publicip",
+ "type": "string"
+ },
+ {
+ "description": "the name of the disk offering of the virtual machine",
+ "name": "diskofferingname",
+ "type": "string"
+ },
+ {
+ "description": "the name of the virtual machine",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the project id of the vm",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the write (io) of disk on the vm",
+ "name": "diskiowrite",
+ "type": "long"
+ },
+ {
"description": "an alternate display text of the ISO attached to the virtual machine",
"name": "isodisplaytext",
"type": "string"
},
{
+ "description": "true if the password rest feature is enabled, false otherwise",
+ "name": "passwordenabled",
+ "type": "boolean"
+ },
+ {
"description": "the list of nics associated with vm",
"name": "nic",
"response": [
{
- "description": "the Secondary ipv4 addr of nic",
- "name": "secondaryip",
+ "description": "true if nic is default, false otherwise",
+ "name": "macaddress",
+ "type": "string"
+ },
+ {
+ "description": "IP addresses associated with NIC found for unmanaged VM",
+ "name": "ipaddresses",
"type": "list"
},
{
- "description": "device id for the network when plugged into the virtual machine",
- "name": "deviceid",
- "type": "string"
- },
- {
- "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise",
- "name": "nsxlogicalswitchport",
- "type": "string"
- },
- {
- "description": "the ip address of the nic",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "description": "the isolated private VLAN type if available",
- "name": "isolatedpvlantype",
- "type": "string"
- },
- {
- "description": "the name of the corresponding network",
- "name": "networkname",
- "type": "string"
- },
- {
- "description": "the cidr of IPv6 network",
- "name": "ip6cidr",
- "type": "string"
- },
- {
- "description": "Type of adapter if available",
- "name": "adaptertype",
- "type": "string"
- },
- {
- "description": "the isolation uri of the nic",
- "name": "isolationuri",
+ "description": "the ID of the corresponding network",
+ "name": "networkid",
"type": "string"
},
{
@@ -85351,33 +86874,48 @@
"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 Secondary ipv4 addr of nic",
+ "name": "secondaryip",
+ "type": "list"
+ },
+ {
+ "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 ip address of the nic",
+ "name": "ipaddress",
+ "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 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 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",
+ "description": "device id for the network when plugged into the virtual machine",
+ "name": "deviceid",
"type": "string"
},
{
@@ -85391,6 +86929,11 @@
"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"
@@ -85401,18 +86944,28 @@
"type": "string"
},
{
- "description": "the broadcast uri of the nic",
- "name": "broadcasturi",
+ "description": "ID of the VLAN/VNI if available",
+ "name": "vlanid",
+ "type": "integer"
+ },
+ {
+ "description": "the type of the nic",
+ "name": "type",
"type": "string"
},
{
- "description": "the ID of the corresponding network",
- "name": "networkid",
+ "description": "the isolation uri of the nic",
+ "name": "isolationuri",
"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": "Id of the NSX Logical Switch Port (if NSX based), null otherwise",
+ "name": "nsxlogicalswitchport",
"type": "string"
},
{
@@ -85421,137 +86974,36 @@
"type": "string"
},
{
- "description": "the IPv6 address of network",
- "name": "ip6address",
+ "description": "the broadcast uri of the nic",
+ "name": "broadcasturi",
"type": "string"
},
{
- "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 outgoing network traffic on the host",
- "name": "networkkbswrite",
- "type": "long"
- },
- {
- "description": "the read (bytes) of disk on the vm",
- "name": "diskkbsread",
- "type": "long"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the ID of the ISO attached to the virtual machine",
- "name": "isoid",
- "type": "string"
- },
- {
- "description": "the write (bytes) of disk on the vm",
- "name": "diskkbswrite",
- "type": "long"
- },
- {
- "description": "the virtual network for the service offering",
- "name": "forvirtualnetwork",
- "type": "boolean"
- },
- {
- "description": "the project id of the vm",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the name of the service offering of the virtual machine",
- "name": "serviceofferingname",
- "type": "string"
- },
- {
- "description": "the ID of the availablility zone for the virtual machine",
- "name": "zoneid",
- "type": "string"
- },
- {
"description": "the date when this virtual machine was updated last time",
"name": "lastupdated",
"type": "date"
},
{
- "description": "State of the Service from LB rule",
- "name": "servicestate",
+ "description": "the ID of the backup offering of the virtual machine",
+ "name": "backupofferingid",
"type": "string"
},
{
- "description": "the project name of the vm",
- "name": "project",
- "type": "string"
+ "description": "the number of cpu this virtual machine is running with",
+ "name": "cpunumber",
+ "type": "integer"
},
{
- "description": "the ID of the service offering of the virtual machine",
- "name": "serviceofferingid",
- "type": "string"
- },
- {
- "description": "the account associated with the virtual machine",
- "name": "account",
- "type": "string"
- },
- {
- "description": "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",
- "type": "string"
- },
- {
- "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 user's ID who deployed the virtual machine",
- "name": "userid",
- "type": "string"
- },
- {
- "description": "an optional field whether to the display the vm to the end user or not.",
- "name": "displayvm",
- "type": "boolean"
- },
- {},
- {
- "description": "ssh key-pair",
- "name": "keypair",
- "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 name of the disk offering of the virtual machine",
- "name": "diskofferingname",
+ "description": "the vgpu type used by the virtual machine",
+ "name": "vgpu",
"type": "string"
},
{
@@ -85560,23 +87012,23 @@
"type": "long"
},
{
- "description": "the name of the template for the virtual machine",
- "name": "templatename",
+ "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": "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": " an alternate display text of the template for the virtual machine",
+ "name": "templatedisplaytext",
+ "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"
},
{
@@ -85585,8 +87037,79 @@
"type": "string"
},
{
- "description": "Os type ID of the virtual machine",
- "name": "guestosid",
+ "description": "the group name of the virtual machine",
+ "name": "group",
+ "type": "string"
+ },
+ {
+ "description": "the group ID of the virtual machine",
+ "name": "groupid",
+ "type": "string"
+ },
+ {
+ "description": "device ID of the root volume",
+ "name": "rootdeviceid",
+ "type": "long"
+ },
+ {
+ "description": "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 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 virtual machine",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the speed of each cpu",
+ "name": "cpuspeed",
+ "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",
+ "name": "networkkbswrite",
+ "type": "long"
+ },
+ {
+ "description": "the name of the ISO attached to the virtual machine",
+ "name": "isoname",
+ "type": "string"
+ },
+ {
+ "description": "OS type id of the vm",
+ "name": "ostypeid",
+ "type": "string"
+ },
+ {
+ "description": "the hypervisor on which the template runs",
+ "name": "hypervisor",
+ "type": "string"
+ },
+ {
+ "description": "the virtual network for the service offering",
+ "name": "forvirtualnetwork",
+ "type": "boolean"
+ },
+ {
+ "description": "Guest vm Boot Type",
+ "name": "boottype",
"type": "string"
},
{
@@ -85594,6 +87117,11 @@
"name": "affinitygroup",
"response": [
{
+ "description": "the type of the affinity group",
+ "name": "type",
+ "type": "string"
+ },
+ {
"description": "the ID of the affinity group",
"name": "id",
"type": "string"
@@ -85604,8 +87132,8 @@
"type": "string"
},
{
- "description": "the type of the affinity group",
- "name": "type",
+ "description": "the domain name of the affinity group",
+ "name": "domain",
"type": "string"
},
{
@@ -85619,13 +87147,13 @@
"type": "string"
},
{
- "description": "the account owning the affinity group",
- "name": "account",
+ "description": "the description of the affinity group",
+ "name": "description",
"type": "string"
},
{
- "description": "the description of the affinity group",
- "name": "description",
+ "description": "the account owning the affinity group",
+ "name": "account",
"type": "string"
},
{
@@ -85637,157 +87165,29 @@
"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 UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the ID of the disk offering of the virtual machine",
+ "name": "diskofferingid",
"type": "string"
},
- {},
- {
- "description": "the total number of network traffic bytes received",
- "name": "receivedbytes",
- "type": "long"
- },
- {
- "description": "public IP address id associated with vm via Static nat rule",
- "name": "publicipid",
- "type": "string"
- },
- {
- "description": "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": "the password (if exists) of the virtual machine",
- "name": "password",
- "type": "string"
- },
- {
- "description": "the name of the domain in which the virtual machine exists",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the list of resource tags associated",
- "name": "tags",
- "response": [
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "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": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- }
- ],
- "type": "set"
- },
{
"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 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 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 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 code for the ICMP message response",
- "name": "icmpcode",
- "type": "integer"
- },
- {
"description": "the protocol of the security group rule",
"name": "protocol",
"type": "string"
@@ -85798,42 +87198,17 @@
"type": "integer"
},
{
- "description": "account owning the security group rule",
- "name": "account",
- "type": "string"
+ "description": "the starting IP of the security group rule",
+ "name": "startport",
+ "type": "integer"
},
{
"description": "the list of resource tags associated with the rule",
"name": "tags",
"response": [
{
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "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"
},
{
@@ -85842,8 +87217,33 @@
"type": "string"
},
{
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
"type": "string"
},
{
@@ -85852,61 +87252,86 @@
"type": "string"
},
{
- "description": "resource type",
- "name": "resourcetype",
+ "description": "the project name where tag belongs to",
+ "name": "project",
"type": "string"
}
],
"type": "set"
+ },
+ {
+ "description": "the type of the ICMP message response",
+ "name": "icmptype",
+ "type": "integer"
+ },
+ {
+ "description": "the code for the ICMP message response",
+ "name": "icmpcode",
+ "type": "integer"
+ },
+ {
+ "description": "the CIDR notation for the base IP address of the security group rule",
+ "name": "cidr",
+ "type": "string"
+ },
+ {
+ "description": "security group name",
+ "name": "securitygroupname",
+ "type": "string"
+ },
+ {
+ "description": "the id of the security group rule",
+ "name": "ruleid",
+ "type": "string"
+ },
+ {
+ "description": "account owning the security group rule",
+ "name": "account",
+ "type": "string"
}
],
"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 domain ID of the security group",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the security group",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the account owning the security group",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the group",
+ "name": "project",
+ "type": "string"
+ },
+ {
"description": "the list of resource tags associated with the rule",
"name": "tags",
"response": [
{
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "the 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": "resource type",
"name": "resourcetype",
"type": "string"
@@ -85917,11 +87342,31 @@
"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": "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"
@@ -85930,115 +87375,6 @@
"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 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": "account owning the security group rule",
- "name": "account",
- "type": "string"
- },
- {
- "description": "security group name",
- "name": "securitygroupname",
- "type": "string"
- },
- {
- "description": "the CIDR notation for the base IP address of the security group rule",
- "name": "cidr",
- "type": "string"
- },
- {
- "description": "the list of resource tags associated with the rule",
- "name": "tags",
- "response": [
- {
- "description": "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 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": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the type of the ICMP message response",
- "name": "icmptype",
- "type": "integer"
- },
- {
- "description": "the code for the ICMP message response",
- "name": "icmpcode",
- "type": "integer"
- }
- ],
- "type": "set"
- },
- {
"description": "the name of the security group",
"name": "name",
"type": "string"
@@ -86049,56 +87385,171 @@
"type": "integer"
},
{
- "description": "the ID of the security group",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the list of virtualmachine ids associated with this securitygroup",
- "name": "virtualmachineids",
+ "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": "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": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "the 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"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the protocol of the security group rule",
+ "name": "protocol",
+ "type": "string"
+ },
+ {
+ "description": "security group name",
+ "name": "securitygroupname",
+ "type": "string"
+ },
+ {
+ "description": "the code for the ICMP message response",
+ "name": "icmpcode",
+ "type": "integer"
+ },
+ {
+ "description": "the ending IP of the security group rule ",
+ "name": "endport",
+ "type": "integer"
+ },
+ {
+ "description": "the starting IP of the security group rule",
+ "name": "startport",
+ "type": "integer"
+ }
+ ],
"type": "set"
},
{
- "description": "the account owning the security group",
- "name": "account",
- "type": "string"
- },
- {
"description": "the domain name of the security group",
"name": "domain",
"type": "string"
+ },
+ {
+ "description": "the project id of the group",
+ "name": "projectid",
+ "type": "string"
}
],
"type": "set"
},
{
- "description": "Vm details in key/value pairs.",
- "name": "details",
- "type": "map"
- },
- {
- "description": "the name of the backup offering of the virtual machine",
- "name": "backupofferingname",
+ "description": "device type of the root volume",
+ "name": "rootdevicetype",
"type": "string"
},
{
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
+ "description": "the name of the host for the virtual machine",
+ "name": "hostname",
+ "type": "string"
},
{
- "description": "the read (io) of disk on the vm",
- "name": "diskioread",
+ "description": "the target memory in vm",
+ "name": "memorytargetkbs",
+ "type": "long"
+ },
+ {},
+ {
+ "description": "the incoming network traffic on the vm",
+ "name": "networkkbsread",
"type": "long"
},
{
- "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": "Guest vm Boot Mode",
- "name": "bootmode",
+ "description": "the amount of the vm's CPU currently used",
+ "name": "cpuused",
+ "type": "string"
+ },
+ {
+ "description": "the write (bytes) of disk on the vm",
+ "name": "diskkbswrite",
+ "type": "long"
+ },
+ {
+ "description": "the password (if exists) of the virtual machine",
+ "name": "password",
+ "type": "string"
+ },
+ {
+ "description": "Os type ID of the virtual machine",
+ "name": "guestosid",
"type": "string"
},
{
@@ -86107,33 +87558,43 @@
"type": "string"
},
{
- "description": "the name of the virtual machine",
- "name": "name",
+ "description": "State of the Service from LB rule",
+ "name": "servicestate",
"type": "string"
},
{
- "description": "the ID of the backup offering of the virtual machine",
- "name": "backupofferingid",
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the name of the template for the virtual machine",
+ "name": "templatename",
"type": "string"
},
{
- "description": "the ID of the 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 group ID of the virtual machine",
- "name": "groupid",
+ "description": "the name of the service offering of the virtual machine",
+ "name": "serviceofferingname",
"type": "string"
},
{
- "description": "the ID of the disk offering of the virtual machine",
- "name": "diskofferingid",
+ "description": "the ID of the domain in which the virtual machine exists",
+ "name": "domainid",
"type": "string"
},
{
- "description": "the name of the availability zone for the virtual machine",
- "name": "zonename",
+ "description": "the ID of the ISO attached to the virtual machine",
+ "name": "isoid",
+ "type": "string"
+ },
+ {
+ "description": "public IP address id associated with vm via Static nat rule",
+ "name": "publicipid",
"type": "string"
},
{
@@ -86142,101 +87603,76 @@
"type": "integer"
},
{
- "description": "the name of the ISO attached to the virtual machine",
- "name": "isoname",
+ "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": "device type of the root volume",
- "name": "rootdevicetype",
- "type": "string"
- },
- {
- "description": "the incoming network traffic on the vm",
- "name": "networkkbsread",
- "type": "long"
- },
- {
- "description": "the number of cpu this virtual machine is running with",
- "name": "cpunumber",
- "type": "integer"
- },
- {
- "description": "the vgpu type used by the virtual machine",
- "name": "vgpu",
- "type": "string"
- },
- {
- "description": "the ID of the virtual machine",
- "name": "id",
- "type": "string"
- },
- {
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
- },
- {
- "description": "the ID of the domain in which the virtual machine exists",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the internal memory that's free in vm or zero if it can not be calculated",
- "name": "memoryintfreekbs",
- "type": "long"
- },
- {
- "description": "the state of the virtual machine",
- "name": "state",
- "type": "string"
- },
- {
- "description": "the speed of each cpu",
- "name": "cpuspeed",
- "type": "integer"
- },
- {
- "description": "instance name of the user vm; this parameter is returned to the ROOT admin only",
- "name": "instancename",
- "type": "string"
- },
- {
- "description": "public IP address id associated with vm via Static nat rule",
- "name": "publicip",
- "type": "string"
- },
- {
- "description": "the target memory in vm",
- "name": "memorytargetkbs",
- "type": "long"
- },
- {
"description": "the memory used by the vm",
"name": "memorykbs",
"type": "long"
},
{
- "description": " an alternate display text of the template for the virtual machine",
- "name": "templatedisplaytext",
- "type": "string"
- },
- {},
- {
- "description": "Guest vm Boot Type",
- "name": "boottype",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
- "description": "the group name of the virtual machine",
- "name": "group",
+ "description": "user generated name. The name of the virtual machine is returned if no displayname exists.",
+ "name": "displayname",
"type": "string"
- }
+ },
+ {
+ "description": "the read (bytes) of disk on the vm",
+ "name": "diskkbsread",
+ "type": "long"
+ },
+ {
+ "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": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.",
+ "name": "isdynamicallyscalable",
+ "type": "boolean"
+ },
+ {
+ "description": "the project name of the vm",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the user's ID who deployed the virtual machine",
+ "name": "userid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the availablility zone for the virtual machine",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "Vm details in key/value pairs.",
+ "name": "details",
+ "type": "map"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "instance name of the user vm; this parameter is returned to the ROOT admin only",
+ "name": "instancename",
+ "type": "string"
+ },
+ {}
]
},
{
@@ -86245,27 +87681,42 @@
"name": "getUploadParamsForTemplate",
"params": [
{
- "description": "the tag for this template.",
+ "description": "the ID of the zone the volume/template is to be hosted on",
"length": 255,
- "name": "templatetag",
- "required": false,
- "type": "string"
+ "name": "zoneid",
+ "related": "createZone,listZones",
+ "required": true,
+ "type": "uuid"
},
{
- "description": "the name of the volume/template",
- "length": 255,
- "name": "name",
+ "description": "the display text of the template. This is usually used for display purposes.",
+ "length": 4096,
+ "name": "displaytext",
"required": true,
"type": "string"
},
{
- "description": "true if this template is a featured template, false otherwise",
+ "description": "true if the template type is routing i.e., if template is used to deploy router",
"length": 255,
- "name": "isfeatured",
+ "name": "isrouting",
"required": false,
"type": "boolean"
},
{
+ "description": "true if this template requires HVM",
+ "length": 255,
+ "name": "requireshvm",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "an optional accountName. Must be used with domainId.",
+ "length": 255,
+ "name": "account",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template",
"length": 255,
"name": "deployasis",
@@ -86274,42 +87725,13 @@
"type": "boolean"
},
{
- "description": "the display text of the template. This is usually used for display purposes.",
- "length": 4096,
- "name": "displaytext",
- "required": true,
- "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": "listDomainChildren,listDomains",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "an optional accountName. Must be used with domainId.",
- "length": 255,
- "name": "account",
- "required": false,
- "type": "string"
- },
- {
- "description": "true if this template requires HVM",
- "length": 255,
- "name": "requireshvm",
+ "name": "passwordenabled",
"required": false,
"type": "boolean"
},
{
- "description": "Template details in key/value pairs.",
- "length": 255,
- "name": "details",
- "required": false,
- "type": "map"
- },
- {
"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",
@@ -86318,13 +87740,56 @@
"type": "uuid"
},
{
- "description": "the format for the volume/template. Possible values include QCOW2, OVA, and VHD.",
+ "description": "Upload volume/template for the project",
"length": 255,
- "name": "format",
- "required": true,
+ "name": "projectid",
+ "related": "activateProject,suspendProject",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "true if the template is available to all accounts; default is true",
+ "length": 255,
+ "name": "ispublic",
+ "required": false,
+ "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": "true if this template is a featured template, false otherwise",
+ "length": 255,
+ "name": "isfeatured",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "the checksum value of this volume/template The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{<algorithm>}\", not including the double quotes. In this <algorithm> is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.",
+ "length": 255,
+ "name": "checksum",
+ "required": false,
"type": "string"
},
{
+ "description": "32 or 64 bits support. 64 by default",
+ "length": 255,
+ "name": "bits",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "Template details in key/value pairs.",
+ "length": 255,
+ "name": "details",
+ "required": false,
+ "type": "map"
+ },
+ {
"description": "true if the template or its derivatives are extractable; default is false",
"length": 255,
"name": "isextractable",
@@ -86339,19 +87804,18 @@
"type": "boolean"
},
{
- "description": "Upload volume/template for the project",
+ "description": "the name of the volume/template",
"length": 255,
- "name": "projectid",
- "related": "activateProject,suspendProject",
- "required": false,
- "type": "uuid"
+ "name": "name",
+ "required": true,
+ "type": "string"
},
{
- "description": "true if the template type is routing i.e., if template is used to deploy router",
+ "description": "the format for the volume/template. Possible values include QCOW2, OVA, and VHD.",
"length": 255,
- "name": "isrouting",
- "required": false,
- "type": "boolean"
+ "name": "format",
+ "required": true,
+ "type": "string"
},
{
"description": "the target hypervisor for the template",
@@ -86361,63 +87825,34 @@
"type": "string"
},
{
- "description": "the ID of the zone the volume/template is to be hosted on",
+ "description": "an optional domainId. If the account parameter is used, domainId must also be used.",
"length": 255,
- "name": "zoneid",
- "related": "createZone,listZones",
- "required": true,
+ "name": "domainid",
+ "related": "listDomainChildren,listDomains",
+ "required": false,
"type": "uuid"
},
{
- "description": "true if the template is available to all accounts; default is true",
+ "description": "the tag for this template.",
"length": 255,
- "name": "ispublic",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "32 or 64 bits support. 64 by default",
- "length": 255,
- "name": "bits",
- "required": false,
- "type": "integer"
- },
- {
- "description": "true if the template supports the password reset feature; default is false",
- "length": 255,
- "name": "passwordenabled",
- "required": false,
- "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 checksum value of this volume/template The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{<algorithm>}\", not including the double quotes. In this <algorithm> is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.",
- "length": 255,
- "name": "checksum",
+ "name": "templatetag",
"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 current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
@@ -86427,21 +87862,22 @@
"name": "postURL",
"type": "url"
},
+ {},
{
"description": "signature to be sent in the POST request.",
"name": "signature",
"type": "string"
},
- {},
{
"description": "encrypted data to be sent in the POST request.",
"name": "metadata",
"type": "string"
},
+ {},
{
- "description": "the timestamp after which the signature expires",
- "name": "expires",
- "type": "string"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
}
],
"since": "4.6.0"
@@ -86462,9 +87898,9 @@
],
"response": [
{
- "description": "true if operation is executed successfully",
- "name": "success",
- "type": "boolean"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
{
"description": "any text associated with the success or failure",
@@ -86473,16 +87909,16 @@
},
{},
{
- "description": "the current status of the latest async job acting 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"
+ }
]
},
{
@@ -86491,6 +87927,13 @@
"name": "updateProjectInvitation",
"params": [
{
+ "description": "account that is joining the project",
+ "length": 255,
+ "name": "account",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "id of the project to join",
"length": 255,
"name": "projectid",
@@ -86499,12 +87942,11 @@
"type": "uuid"
},
{
- "description": "User UUID, required for adding account from external provisioning system",
+ "description": "list invitations for specified account; this parameter has to be specified with domainId",
"length": 255,
- "name": "userid",
- "related": "createUser,enableUser,getUser",
+ "name": "token",
"required": false,
- "type": "uuid"
+ "type": "string"
},
{
"description": "if true, accept the invitation, decline if false. True by default",
@@ -86514,25 +87956,19 @@
"type": "boolean"
},
{
- "description": "account that is joining the project",
+ "description": "User UUID, required for adding account from external provisioning system",
"length": 255,
- "name": "account",
+ "name": "userid",
+ "related": "createUser,enableUser,getUser",
"required": false,
- "type": "string"
- },
- {
- "description": "list invitations for specified account; this parameter has to be specified with domainId",
- "length": 255,
- "name": "token",
- "required": false,
- "type": "string"
+ "type": "uuid"
}
],
"response": [
{
- "description": "true if operation is executed successfully",
- "name": "success",
- "type": "boolean"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
{},
{
@@ -86547,9 +87983,9 @@
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "true if operation is executed successfully",
+ "name": "success",
+ "type": "boolean"
}
],
"since": "3.0.0"
@@ -86571,19 +88007,8 @@
"related": "",
"response": [
{
- "description": " the date the snapshot was created",
- "name": "created",
- "type": "date"
- },
- {},
- {
- "description": "ID of the disk volume",
- "name": "volumeid",
- "type": "string"
- },
- {
- "description": "id of the availability zone",
- "name": "zoneid",
+ "description": "the type of the snapshot",
+ "name": "snapshottype",
"type": "string"
},
{
@@ -86592,78 +88017,6 @@
"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": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the 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": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the project id of the snapshot",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "name of the snapshot",
- "name": "name",
- "type": "string"
- },
- {
"description": "virtual size of backedup snapshot on image store",
"name": "virtualsize",
"type": "long"
@@ -86674,81 +88027,164 @@
"type": "string"
},
{
- "description": "valid types are hourly, daily, weekly, monthy, template, and none.",
- "name": "intervaltype",
- "type": "string"
- },
- {
- "description": "type of the disk volume",
- "name": "volumetype",
- "type": "string"
- },
- {
- "description": "display name of the os on volume",
- "name": "osdisplayname",
- "type": "string"
- },
- {
"description": "valid location types are primary and secondary.",
"name": "locationtype",
"type": "string"
},
{
- "description": "name of the disk volume",
- "name": "volumename",
- "type": "string"
- },
- {
- "description": "the project name of the snapshot",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage",
- "name": "state",
- "type": "state"
- },
- {
- "description": "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": "indicates whether the underlying storage supports reverting the volume to this snapshot",
- "name": "revertable",
- "type": "boolean"
- },
- {
- "description": "id of the os on volume",
- "name": "ostypeid",
- "type": "string"
- },
- {
- "description": "the domain ID of the snapshot's account",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the account associated with the snapshot",
- "name": "account",
- "type": "string"
- },
- {
"description": "physical size of backedup snapshot on image store",
"name": "physicalsize",
"type": "long"
},
{
+ "description": " the date the snapshot was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "indicates whether the underlying storage supports reverting the volume to this snapshot",
+ "name": "revertable",
+ "type": "boolean"
+ },
+ {
+ "description": "the account associated with the snapshot",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the project id of the snapshot",
+ "name": "projectid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the project name of the snapshot",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "valid types are hourly, daily, weekly, monthy, template, and none.",
+ "name": "intervaltype",
+ "type": "string"
+ },
+ {
+ "description": "ID of the disk volume",
+ "name": "volumeid",
+ "type": "string"
+ },
+ {
+ "description": "display name of the os on volume",
+ "name": "osdisplayname",
+ "type": "string"
+ },
+ {
+ "description": "id of the availability zone",
+ "name": "zoneid",
+ "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": "name of the snapshot",
+ "name": "name",
+ "type": "string"
+ },
+ {
"description": "true if the entity/resource has annotations",
"name": "hasannotations",
"type": "boolean"
},
- {}
+ {},
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "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": "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 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": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "id of the os on volume",
+ "name": "ostypeid",
+ "type": "string"
+ },
+ {
+ "description": "type of the disk volume",
+ "name": "volumetype",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID of the snapshot's account",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "name of the disk volume",
+ "name": "volumename",
+ "type": "string"
+ }
]
},
{
@@ -86757,20 +88193,6 @@
"name": "listRegions",
"params": [
{
- "description": "",
- "length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
- },
- {
- "description": "",
- "length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
- },
- {
"description": "List Region by region ID.",
"length": 255,
"name": "id",
@@ -86778,6 +88200,20 @@
"type": "integer"
},
{
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
"description": "List Region by region name.",
"length": 255,
"name": "name",
@@ -86785,11 +88221,11 @@
"type": "string"
},
{
- "description": "List by keyword",
+ "description": "",
"length": 255,
- "name": "keyword",
+ "name": "page",
"required": false,
- "type": "string"
+ "type": "integer"
}
],
"related": "addRegion",
@@ -86805,8 +88241,19 @@
"type": "integer"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the name of the region",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "true if GSLB service is enabled in the region, false otherwise",
+ "name": "gslbserviceenabled",
+ "type": "boolean"
+ },
+ {},
+ {
+ "description": "the end point of the region",
+ "name": "endpoint",
"type": "string"
},
{
@@ -86816,20 +88263,9 @@
},
{},
{
- "description": "the name of the region",
- "name": "name",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
- },
- {
- "description": "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"
}
]
},
@@ -86839,14 +88275,6 @@
"name": "migrateSystemVm",
"params": [
{
- "description": "Automatically select a destination host which do not require storage migration, if hostId and storageId are not specified. false by default",
- "length": 255,
- "name": "autoselect",
- "required": false,
- "since": "4.16.0",
- "type": "boolean"
- },
- {
"description": "the ID of the virtual machine",
"length": 255,
"name": "virtualmachineid",
@@ -86855,48 +88283,36 @@
"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,syncStoragePool",
- "required": false,
- "since": "4.16.0",
- "type": "uuid"
- },
- {
"description": "destination Host ID to migrate VM to",
"length": 255,
"name": "hostid",
"related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost",
"required": false,
"type": "uuid"
+ },
+ {
+ "description": "Automatically select a destination host which do not require storage migration, if hostId and storageId are not specified. false by default",
+ "length": 255,
+ "name": "autoselect",
+ "required": false,
+ "since": "4.16.0",
+ "type": "boolean"
+ },
+ {
+ "description": "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,syncStoragePool",
+ "required": false,
+ "since": "4.16.0",
+ "type": "uuid"
}
],
"related": "",
"response": [
{
- "description": "the link local MAC address for the system vm",
- "name": "linklocalmacaddress",
- "type": "string"
- },
- {
- "description": "the ID of the system VM",
- "name": "id",
- "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 second DNS for the system VM",
- "name": "dns2",
+ "description": "the Pod ID for the system VM",
+ "name": "podid",
"type": "string"
},
{
@@ -86905,85 +88321,99 @@
"type": "string"
},
{
- "description": "the link local netmask for the system vm",
- "name": "linklocalnetmask",
+ "description": "the template name for the system VM",
+ "name": "templatename",
"type": "string"
},
- {},
+ {
+ "description": "the 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 Zone ID for the system VM",
+ "name": "zoneid",
+ "type": "string"
+ },
{
"description": "the public netmask for the system VM",
"name": "publicnetmask",
"type": "string"
},
{
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "the public MAC address for the system VM",
- "name": "publicmacaddress",
- "type": "string"
- },
- {},
- {
"description": "the gateway for the system VM",
"name": "gateway",
"type": "string"
},
{
- "description": "the template name for the system VM",
- "name": "templatename",
- "type": "string"
- },
- {
- "description": "the first DNS for the system VM",
- "name": "dns1",
- "type": "string"
- },
- {
- "description": "the host ID for the system VM",
- "name": "hostid",
- "type": "string"
- },
- {
- "description": "the system VM type",
- "name": "systemvmtype",
- "type": "string"
- },
- {
- "description": "guest vlan range",
- "name": "guestvlan",
- "type": "string"
- },
- {
"description": "the network domain for the system VM",
"name": "networkdomain",
"type": "string"
},
{
+ "description": "the systemvm agent version",
+ "name": "version",
+ "type": "string"
+ },
+ {
+ "description": "the second DNS for the system VM",
+ "name": "dns2",
+ "type": "string"
+ },
+ {
+ "description": "the private IP address for the system VM",
+ "name": "privateip",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the template ID for the system VM",
+ "name": "templateid",
+ "type": "string"
+ },
+ {
"description": "the hypervisor on which the template runs",
"name": "hypervisor",
"type": "string"
},
{
- "description": "the private netmask for the system VM",
- "name": "privatenetmask",
+ "description": "the link local netmask for the system vm",
+ "name": "linklocalnetmask",
"type": "string"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the ID of the system VM",
+ "name": "id",
"type": "string"
},
{
- "description": "the agent state of the system VM",
- "name": "agentstate",
+ "description": "the hostname for the system VM",
+ "name": "hostname",
"type": "string"
},
{
- "description": "the systemvm agent version",
- "name": "version",
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the public MAC address for the system VM",
+ "name": "publicmacaddress",
+ "type": "string"
+ },
+ {
+ "description": "the first DNS for the system VM",
+ "name": "dns1",
+ "type": "string"
+ },
+ {
+ "description": "the state of the system VM",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "guest vlan range",
+ "name": "guestvlan",
"type": "string"
},
{
@@ -86997,18 +88427,28 @@
"type": "list"
},
{
- "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the template ID for the system VM",
- "name": "templateid",
+ "description": "the Pod name for the system VM",
+ "name": "podname",
"type": "string"
},
{
- "description": "the Pod ID for the system VM",
- "name": "podid",
+ "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.",
+ "name": "isdynamicallyscalable",
+ "type": "boolean"
+ },
+ {
+ "description": "the host ID for the system VM",
+ "name": "hostid",
+ "type": "string"
+ },
+ {
+ "description": "the private netmask for the system VM",
+ "name": "privatenetmask",
+ "type": "string"
+ },
+ {
+ "description": "the public IP address for the system VM",
+ "name": "publicip",
"type": "string"
},
{
@@ -87017,59 +88457,55 @@
"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 hostname for the system VM",
- "name": "hostname",
- "type": "string"
- },
- {
- "description": "the Zone ID for the system VM",
- "name": "zoneid",
- "type": "string"
- },
- {
"description": "the number of active console sessions for the console proxy system vm",
"name": "activeviewersessions",
"type": "integer"
},
{
- "description": "the public 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 last disconnected date of host",
- "name": "disconnected",
- "type": "date"
- },
- {
"description": "the name of the system VM",
"name": "name",
"type": "string"
},
{
+ "description": "the agent state of the system VM",
+ "name": "agentstate",
+ "type": "string"
+ },
+ {
"description": "the private MAC address for the system VM",
"name": "privatemacaddress",
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "the last disconnected date of host",
+ "name": "disconnected",
+ "type": "date"
},
{
- "description": "the private IP address for the system VM",
- "name": "privateip",
+ "description": "the system VM type",
+ "name": "systemvmtype",
"type": "string"
},
{
- "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.",
- "name": "isdynamicallyscalable",
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
"type": "boolean"
+ },
+ {
+ "description": "the 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"
}
]
},
@@ -87081,11 +88517,32 @@
{
"description": "",
"length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "",
+ "length": 255,
"name": "pagesize",
"required": false,
"type": "integer"
},
{
+ "description": "Source of the counter.",
+ "length": 255,
+ "name": "source",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "Name of the counter.",
+ "length": 255,
+ "name": "name",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "List by keyword",
"length": 255,
"name": "keyword",
@@ -87099,50 +88556,13 @@
"related": "createCounter,listCounters",
"required": false,
"type": "uuid"
- },
- {
- "description": "",
- "length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
- },
- {
- "description": "Source of the counter.",
- "length": 255,
- "name": "source",
- "required": false,
- "type": "string"
- },
- {
- "description": "Name of the counter.",
- "length": 255,
- "name": "name",
- "required": false,
- "type": "string"
}
],
"related": "createCounter",
"response": [
{
- "description": "the id of the Counter",
- "name": "id",
- "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": "zone id of counter",
- "name": "zoneid",
+ "description": "Value in case of snmp or other specific counters.",
+ "name": "value",
"type": "string"
},
{
@@ -87150,14 +88570,30 @@
"name": "name",
"type": "string"
},
+ {},
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "zone id of counter",
+ "name": "zoneid",
+ "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": "the id of the Counter",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "Source of the counter.",
+ "name": "source",
"type": "string"
},
{}
@@ -87169,24 +88605,38 @@
"name": "configureInternalLoadBalancerElement",
"params": [
{
+ "description": "Enables/Disables the Internal Load Balancer element",
+ "length": 255,
+ "name": "enabled",
+ "required": true,
+ "type": "boolean"
+ },
+ {
"description": "the ID of the internal lb provider",
"length": 255,
"name": "id",
"related": "configureInternalLoadBalancerElement",
"required": true,
"type": "uuid"
- },
- {
- "description": "Enables/Disables the Internal Load Balancer element",
- "length": 255,
- "name": "enabled",
- "required": true,
- "type": "boolean"
}
],
"related": "",
"response": [
- {},
+ {
+ "description": "the physical network service provider id of the element",
+ "name": "nspid",
+ "type": "string"
+ },
+ {
+ "description": "Enabled/Disabled the element",
+ "name": "enabled",
+ "type": "boolean"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
@@ -87198,21 +88648,7 @@
"type": "string"
},
{},
- {
- "description": "the physical network service provider id of the element",
- "name": "nspid",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "Enabled/Disabled the element",
- "name": "enabled",
- "type": "boolean"
- }
+ {}
],
"since": "4.2.0"
},
@@ -87244,6 +88680,14 @@
"type": "string"
},
{
+ "description": "list virtual router elements by network service provider id",
+ "length": 255,
+ "name": "nspid",
+ "related": "listNetworkServiceProviders",
+ "required": false,
+ "type": "uuid"
+ },
+ {
"description": "",
"length": 255,
"name": "page",
@@ -87256,38 +88700,19 @@
"name": "enabled",
"required": false,
"type": "boolean"
- },
- {
- "description": "list virtual router elements by network service provider id",
- "length": 255,
- "name": "nspid",
- "related": "listNetworkServiceProviders",
- "required": false,
- "type": "uuid"
}
],
"related": "",
"response": [
{
- "description": "the domain associated with the provider",
- "name": "domain",
- "type": "string"
- },
- {},
- {
- "description": "the project name of the address",
- "name": "project",
- "type": "string"
- },
- {
"description": "Enabled/Disabled the service provider",
"name": "enabled",
"type": "boolean"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
{
"description": "the domain ID associated with the provider",
@@ -87305,21 +88730,32 @@
"type": "string"
},
{
- "description": "the project id of the ipaddress",
- "name": "projectid",
+ "description": "the project name of the address",
+ "name": "project",
"type": "string"
},
- {},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "the domain associated with the provider",
+ "name": "domain",
+ "type": "string"
},
{
"description": "the account associated with the provider",
"name": "account",
"type": "string"
- }
+ },
+ {},
+ {
+ "description": "the project id of the ipaddress",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {}
]
},
{
@@ -87350,23 +88786,23 @@
"name": "jobstatus",
"type": "integer"
},
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
+ {},
{
"description": "true if operation is executed successfully",
"name": "success",
"type": "boolean"
},
+ {},
{
"description": "any text associated with the success or failure",
"name": "displaytext",
"type": "string"
},
- {},
- {}
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ }
]
},
{
@@ -87375,20 +88811,6 @@
"name": "listTrafficTypeImplementors",
"params": [
{
- "description": "",
- "length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
- },
- {
- "description": "Optional. The network traffic type, if specified, return its implementor. Otherwise, return all traffic types with their implementor",
- "length": 255,
- "name": "traffictype",
- "required": false,
- "type": "string"
- },
- {
"description": "List by keyword",
"length": 255,
"name": "keyword",
@@ -87398,20 +88820,32 @@
{
"description": "",
"length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "",
+ "length": 255,
"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": "",
"response": [
- {},
{
"description": "network traffic type",
"name": "traffictype",
"type": "string"
},
- {},
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
@@ -87426,7 +88860,9 @@
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
- }
+ },
+ {},
+ {}
],
"since": "3.0.0"
},
@@ -87436,20 +88872,6 @@
"name": "linkAccountToLdap",
"params": [
{
- "description": "name of the group or OU in LDAP",
- "length": 255,
- "name": "ldapdomain",
- "required": true,
- "type": "string"
- },
- {
- "description": "name of the account, it will be created if it does not exist",
- "length": 255,
- "name": "account",
- "required": true,
- "type": "string"
- },
- {
"description": "type of the ldap name. GROUP or OU, defaults to GROUP",
"length": 255,
"name": "type",
@@ -87472,43 +88894,36 @@
"type": "string"
},
{
+ "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,
"name": "accounttype",
"required": true,
"type": "short"
+ },
+ {
+ "description": "name of the account, it will be created if it does not exist",
+ "length": 255,
+ "name": "account",
+ "required": true,
+ "type": "string"
}
],
"related": "",
"response": [
{
- "description": "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": "short"
},
{},
{
- "description": "id of the Domain which is linked to LDAP",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "type of the name in LDAP which is linke 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": "Domain Admin accountId that is created",
"name": "accountid",
"type": "string"
@@ -87519,9 +88934,30 @@
"type": "string"
},
{
+ "description": "type of the name in LDAP which is linke to the domain",
+ "name": "type",
+ "type": "string"
+ },
+ {},
+ {
+ "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": "ldapdomain",
"type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "id of the Domain which is linked to LDAP",
+ "name": "domainid",
+ "type": "string"
}
],
"since": "4.11.0"
@@ -87542,27 +88978,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": "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.2.0"
},
@@ -87572,6 +89008,28 @@
"name": "listAutoScaleVmProfiles",
"params": [
{
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "the otherdeployparameters of the autoscale vm profile",
+ "length": 255,
+ "name": "otherdeployparams",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter",
+ "length": 255,
+ "name": "fordisplay",
+ "required": false,
+ "since": "4.4",
+ "type": "boolean"
+ },
+ {
"description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false",
"length": 255,
"name": "listall",
@@ -87579,10 +89037,10 @@
"type": "boolean"
},
{
- "description": "the templateid of the autoscale vm profile",
+ "description": "the ID of the autoscale vm profile",
"length": 255,
- "name": "templateid",
- "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos",
+ "name": "id",
+ "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles",
"required": false,
"type": "uuid"
},
@@ -87596,12 +89054,27 @@
"type": "uuid"
},
{
- "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter",
+ "description": "list objects by project",
"length": 255,
- "name": "fordisplay",
+ "name": "projectid",
+ "related": "activateProject,suspendProject",
"required": false,
- "since": "4.4",
- "type": "boolean"
+ "type": "uuid"
+ },
+ {
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the templateid of the autoscale vm profile",
+ "length": 255,
+ "name": "templateid",
+ "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos",
+ "required": false,
+ "type": "uuid"
},
{
"description": "list resources by account. Must be used with the domainId parameter.",
@@ -87618,28 +89091,6 @@
"type": "integer"
},
{
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
- },
- {
- "description": "",
- "length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
- },
- {
- "description": "list only resources belonging to the domain specified",
- "length": 255,
- "name": "domainid",
- "related": "listDomainChildren,listDomains",
- "required": false,
- "type": "uuid"
- },
- {
"description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
"length": 255,
"name": "isrecursive",
@@ -87647,21 +89098,6 @@
"type": "boolean"
},
{
- "description": "list objects by project",
- "length": 255,
- "name": "projectid",
- "related": "activateProject,suspendProject",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "the otherdeployparameters of the autoscale vm profile",
- "length": 255,
- "name": "otherdeployparams",
- "required": false,
- "type": "string"
- },
- {
"description": "list profiles by service offering id",
"length": 255,
"name": "serviceofferingid",
@@ -87671,17 +89107,16 @@
"type": "uuid"
},
{
- "description": "the ID of the autoscale vm profile",
+ "description": "list only resources belonging to the domain specified",
"length": 255,
- "name": "id",
- "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles",
+ "name": "domainid",
+ "related": "listDomainChildren,listDomains",
"required": false,
"type": "uuid"
}
],
"related": "createAutoScaleVmProfile",
"response": [
- {},
{
"description": "the time allowed for existing connections to get closed before a vm is destroyed",
"name": "destroyvmgraceperiod",
@@ -87693,23 +89128,13 @@
"type": "string"
},
{
- "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",
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the template to be used while deploying a virtual machine",
- "name": "templateid",
+ "description": "the account owning the instance group",
+ "name": "account",
"type": "string"
},
{},
@@ -87718,13 +89143,17 @@
"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 vm profile",
"name": "domainid",
"type": "string"
},
- {},
- {},
{
"description": "the project id vm profile",
"name": "projectid",
@@ -87736,13 +89165,20 @@
"type": "string"
},
{
+ "description": "the availability zone to be used while deploying a virtual machine",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {},
+ {},
+ {
"description": "the service offering to be used while deploying a virtual machine",
"name": "serviceofferingid",
"type": "string"
},
{
- "description": "the account owning the instance group",
- "name": "account",
+ "description": "the template to be used while deploying a virtual machine",
+ "name": "templateid",
"type": "string"
},
{
@@ -87751,14 +89187,14 @@
"type": "string"
},
{
- "description": "the ID of the user used to launch and destroy the VMs",
- "name": "autoscaleuserid",
- "type": "string"
- },
- {
"description": "is profile for display to the regular user",
"name": "fordisplay",
"type": "boolean"
+ },
+ {
+ "description": "the ID of the user used to launch and destroy the VMs",
+ "name": "autoscaleuserid",
+ "type": "string"
}
]
},
@@ -87779,8 +89215,28 @@
"related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForCluster",
"response": [
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the out-of-band management interface port",
+ "name": "port",
+ "type": "string"
+ },
+ {
+ "description": "the operation result description",
+ "name": "description",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the host",
+ "name": "hostid",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the out-of-band management driver for the host",
+ "name": "driver",
"type": "string"
},
{
@@ -87789,6 +89245,11 @@
"type": "boolean"
},
{
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
"description": "the out-of-band management interface address",
"name": "address",
"type": "string"
@@ -87798,14 +89259,10 @@
"name": "enabled",
"type": "boolean"
},
+ {},
{
- "description": "the out-of-band management interface password",
- "name": "password",
- "type": "string"
- },
- {
- "description": "the out-of-band management driver for the host",
- "name": "driver",
+ "description": "the out-of-band management action (if issued)",
+ "name": "action",
"type": "string"
},
{
@@ -87814,36 +89271,15 @@
"type": "powerstate"
},
{
+ "description": "the out-of-band management interface password",
+ "name": "password",
+ "type": "string"
+ },
+ {},
+ {
"description": "the out-of-band management interface username",
"name": "username",
"type": "string"
- },
- {},
- {
- "description": "the out-of-band management action (if issued)",
- "name": "action",
- "type": "string"
- },
- {
- "description": "the out-of-band management interface port",
- "name": "port",
- "type": "string"
- },
- {
- "description": "the ID of the host",
- "name": "hostid",
- "type": "string"
- },
- {},
- {
- "description": "the operation result description",
- "name": "description",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
}
],
"since": "4.9.0"
@@ -87865,29 +89301,43 @@
"related": "reconnectHost,addBaremetalHost",
"response": [
{
+ "description": "the Pod name of the host",
+ "name": "podname",
+ "type": "string"
+ },
+ {
+ "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 amount of the host's CPU currently allocated in percentage",
+ "name": "cpuallocatedpercentage",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the host's CPU currently allocated in MHz",
+ "name": "cpuallocatedvalue",
+ "type": "long"
+ },
+ {
+ "description": "the amount of the host's memory currently allocated",
+ "name": "memoryallocated",
+ "type": "long"
+ },
+ {
"description": "the last time this host was annotated",
"name": "lastannotated",
"type": "date"
},
{
- "description": "the OS category name of the host",
- "name": "oscategoryname",
- "type": "string"
- },
- {},
- {
- "description": "the hypervisor version",
- "name": "hypervisorversion",
- "type": "string"
- },
- {
- "description": "the cpu average load on the host",
- "name": "cpuloadaverage",
- "type": "double"
- },
- {
- "description": "comma-separated list of tags for the host",
- "name": "hosttags",
+ "description": "capabilities of the host",
+ "name": "capabilities",
"type": "string"
},
{
@@ -87901,38 +89351,8 @@
"type": "string"
},
{
- "description": "the host out-of-band management information",
- "name": "outofbandmanagement",
- "type": "outofbandmanagementresponse"
- },
- {
- "description": "the amount of the host's memory after applying the mem.overprovisioning.factor",
- "name": "memorywithoverprovisioning",
- "type": "string"
- },
- {
- "description": "the state of the host",
- "name": "state",
- "type": "status"
- },
- {
- "description": "the CPU number of the host",
- "name": "cpunumber",
- "type": "integer"
- },
- {
- "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning",
- "name": "memorytotal",
- "type": "long"
- },
- {
- "description": "the amount of the host's memory currently allocated in bytes",
- "name": "memoryallocatedbytes",
- "type": "long"
- },
- {
- "description": "the name of the host",
- "name": "name",
+ "description": "the amount of the host's memory currently allocated in percentage",
+ "name": "memoryallocatedpercentage",
"type": "string"
},
{
@@ -87941,16 +89361,11 @@
"type": "boolean"
},
{
- "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor",
- "name": "cpuwithoverprovisioning",
+ "description": "the OS category ID of the host",
+ "name": "oscategoryid",
"type": "string"
},
{
- "description": "the date and time the host was last pinged",
- "name": "lastpinged",
- "type": "date"
- },
- {
"description": "the Zone name of the host",
"name": "zonename",
"type": "string"
@@ -87961,74 +89376,13 @@
"type": "boolean"
},
{
- "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 resource state of the host",
- "name": "resourcestate",
- "type": "string"
- },
- {
- "description": "the cluster type of the cluster that host belongs to",
- "name": "clustertype",
- "type": "string"
- },
- {
- "description": "the outgoing network traffic on the host",
- "name": "networkkbswrite",
- "type": "long"
- },
- {
- "description": "the management server ID of the host",
- "name": "managementserverid",
- "type": "string"
- },
- {
- "description": "the Pod ID of the host",
- "name": "podid",
- "type": "string"
- },
- {},
- {
- "description": "the Pod name of the host",
- "name": "podname",
- "type": "string"
- },
- {
- "description": "the host hypervisor",
- "name": "hypervisor",
- "type": "hypervisortype"
- },
- {
- "description": "the IP address of the host",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "description": "the admin that annotated this host",
- "name": "username",
- "type": "string"
- },
- {
- "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": "true if the host has capability to support UEFI boot",
- "name": "ueficapability",
- "type": "boolean"
- },
- {
- "description": "the incoming network traffic on the host",
- "name": "networkkbsread",
+ "description": "the amount of the host's memory currently used",
+ "name": "memoryused",
"type": "long"
},
{
@@ -88042,78 +89396,14 @@
"type": "string"
},
{
- "description": "the date and time the host was removed",
- "name": "removed",
- "type": "date"
+ "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise",
+ "name": "hasenoughcapacity",
+ "type": "boolean"
},
{
- "description": "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": "Video RAM for this vGPU type",
- "name": "videoram",
- "type": "long"
- },
- {
- "description": "Maximum vgpu can be created with this vgpu type on the given gpu group",
- "name": "maxcapacity",
- "type": "long"
- },
- {
- "description": "Maximum X resolution per display",
- "name": "maxresolutionx",
- "type": "long"
- },
- {
- "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type",
- "name": "remainingcapacity",
- "type": "long"
- },
- {
- "description": "Maximum displays per user",
- "name": "maxheads",
- "type": "long"
- },
- {
- "description": "Maximum Y resolution per display",
- "name": "maxresolutiony",
- "type": "long"
- },
- {
- "description": "Maximum no. of vgpu per gpu card (pgpu)",
- "name": "maxvgpuperpgpu",
- "type": "long"
- }
- ],
- "type": "list"
- },
- {
- "description": "GPU cards present in the host",
- "name": "gpugroupname",
- "type": "string"
- }
- ],
- "type": "list"
- },
- {
- "description": "the host type",
- "name": "type",
- "type": "type"
- },
- {
- "description": "the CPU speed of the host",
- "name": "cpuspeed",
- "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",
@@ -88121,23 +89411,13 @@
"type": "integer"
},
{
- "description": "the total disk size of the host",
- "name": "disksizetotal",
- "type": "long"
- },
- {
- "description": "the date and time the host was created",
- "name": "created",
+ "description": "the date and time the host was removed",
+ "name": "removed",
"type": "date"
},
{
- "description": "the cluster ID of the host",
- "name": "clusterid",
- "type": "string"
- },
- {
- "description": "the ID of the host",
- "name": "id",
+ "description": "the Zone ID of the host",
+ "name": "zoneid",
"type": "string"
},
{
@@ -88146,84 +89426,240 @@
"type": "string"
},
{
+ "description": "the state of the host",
+ "name": "state",
+ "type": "status"
+ },
+ {
+ "description": "the date and time the host was last pinged",
+ "name": "lastpinged",
+ "type": "date"
+ },
+ {
+ "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise",
+ "name": "hahost",
+ "type": "boolean"
+ },
+ {
+ "description": "the host out-of-band management information",
+ "name": "outofbandmanagement",
+ "type": "outofbandmanagementresponse"
+ },
+ {
+ "description": "the hypervisor version",
+ "name": "hypervisorversion",
+ "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 outgoing network traffic on the host",
+ "name": "networkkbswrite",
+ "type": "long"
+ },
+ {
+ "description": "the management server ID of the host",
+ "name": "managementserverid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the amount of the host's memory after applying the mem.overprovisioning.factor",
+ "name": "memorywithoverprovisioning",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the host",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "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": "Maximum X resolution per display",
+ "name": "maxresolutionx",
+ "type": "long"
+ },
+ {
+ "description": "Video RAM for this vGPU type",
+ "name": "videoram",
+ "type": "long"
+ },
+ {
+ "description": "Maximum displays per user",
+ "name": "maxheads",
+ "type": "long"
+ },
+ {
+ "description": "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 no. of vgpu per gpu card (pgpu)",
+ "name": "maxvgpuperpgpu",
+ "type": "long"
+ },
+ {
+ "description": "Maximum vgpu can be created with this vgpu type on the given gpu group",
+ "name": "maxcapacity",
+ "type": "long"
+ }
+ ],
+ "type": "list"
+ }
+ ],
+ "type": "list"
+ },
+ {
+ "description": "the cluster ID of the host",
+ "name": "clusterid",
+ "type": "string"
+ },
+ {
+ "description": "the host version",
+ "name": "version",
+ "type": "string"
+ },
+ {
+ "description": "the CPU speed of the host",
+ "name": "cpuspeed",
+ "type": "long"
+ },
+ {
+ "description": "the amount of the host's memory currently allocated in bytes",
+ "name": "memoryallocatedbytes",
+ "type": "long"
+ },
+ {
+ "description": "the Pod ID of the host",
+ "name": "podid",
+ "type": "string"
+ },
+ {
+ "description": "the total disk size of the host",
+ "name": "disksizetotal",
+ "type": "long"
+ },
+ {
"description": "the amount of the host's CPU currently allocated",
"name": "cpuallocated",
"type": "string"
},
{
+ "description": "the IP address of the host",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "comma-separated list of tags for the host",
+ "name": "hosttags",
+ "type": "string"
+ },
+ {
"description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor",
"name": "cpuallocatedwithoverprovisioning",
"type": "string"
},
{
- "description": "the amount of the host's memory currently allocated",
- "name": "memoryallocated",
- "type": "long"
+ "description": "the admin that annotated this host",
+ "name": "username",
+ "type": "string"
},
{
- "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise",
- "name": "hahost",
- "type": "boolean"
+ "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor",
+ "name": "cpuwithoverprovisioning",
+ "type": "string"
},
{
"description": "the host's currently allocated disk size",
"name": "disksizeallocated",
"type": "long"
},
+ {},
+ {
+ "description": "the host hypervisor",
+ "name": "hypervisor",
+ "type": "hypervisortype"
+ },
+ {
+ "description": "the resource state of the host",
+ "name": "resourcestate",
+ "type": "string"
+ },
+ {
+ "description": "the name of the host",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "Host details in key/value pairs.",
+ "name": "details",
+ "type": "map"
+ },
+ {
+ "description": "the OS category name of the host",
+ "name": "oscategoryname",
+ "type": "string"
+ },
+ {
+ "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning",
+ "name": "memorytotal",
+ "type": "long"
+ },
+ {
+ "description": "the cpu average load on the host",
+ "name": "cpuloadaverage",
+ "type": "double"
+ },
{
"description": "true if the host is disconnected. False otherwise.",
"name": "disconnected",
"type": "date"
},
{
+ "description": "the date and time the host was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
"description": "the number of CPU sockets on the host",
"name": "cpusockets",
"type": "integer"
},
{
- "description": "Host details in key/value pairs.",
- "name": "details",
- "type": "map"
- },
- {
- "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise",
- "name": "suitableformigration",
- "type": "boolean"
- },
- {
- "description": "the amount of the host's memory currently used",
- "name": "memoryused",
+ "description": "the incoming network traffic on the host",
+ "name": "networkkbsread",
"type": "long"
- },
- {
- "description": "the host version",
- "name": "version",
- "type": "string"
- },
- {
- "description": "capabilities of the host",
- "name": "capabilities",
- "type": "string"
- },
- {
- "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise",
- "name": "hasenoughcapacity",
- "type": "boolean"
- },
- {
- "description": "the Zone 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": "the amount of the host's memory currently allocated in percentage",
- "name": "memoryallocatedpercentage",
- "type": "string"
}
],
"since": "4.16.0.0"
@@ -88234,45 +89670,25 @@
"name": "authorizeSecurityGroupIngress",
"params": [
{
- "description": "end port for this ingress rule",
+ "description": "the cidr list associated. Multiple entries must be separated by a single comma character (,).",
"length": 255,
- "name": "endport",
+ "name": "cidrlist",
"required": false,
- "type": "integer"
+ "type": "list"
},
{
- "description": "type of the icmp message being sent",
+ "description": "The ID of the security group. Mutually exclusive with securityGroupName parameter",
"length": 255,
- "name": "icmptype",
+ "name": "securitygroupid",
+ "related": "createSecurityGroup",
"required": false,
- "type": "integer"
+ "type": "uuid"
},
{
- "description": "The name of the security group. Mutually exclusive with securityGroupId parameter",
+ "description": "an optional project of the security group",
"length": 255,
- "name": "securitygroupname",
- "required": false,
- "type": "string"
- },
- {
- "description": "an optional account for the security group. Must be used with domainId.",
- "length": 255,
- "name": "account",
- "required": false,
- "type": "string"
- },
- {
- "description": "user to security group mapping",
- "length": 255,
- "name": "usersecuritygrouplist",
- "required": false,
- "type": "map"
- },
- {
- "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.",
- "length": 255,
- "name": "domainid",
- "related": "listDomainChildren,listDomains",
+ "name": "projectid",
+ "related": "activateProject,suspendProject",
"required": false,
"type": "uuid"
},
@@ -88284,12 +89700,25 @@
"type": "string"
},
{
- "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": "activateProject,suspendProject",
+ "name": "securitygroupname",
"required": false,
- "type": "uuid"
+ "type": "string"
+ },
+ {
+ "description": "end port for this ingress rule",
+ "length": 255,
+ "name": "endport",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "an optional account for the security group. Must be used with domainId.",
+ "length": 255,
+ "name": "account",
+ "required": false,
+ "type": "string"
},
{
"description": "start port for this ingress rule",
@@ -88299,26 +89728,33 @@
"type": "integer"
},
{
+ "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.",
+ "length": 255,
+ "name": "domainid",
+ "related": "listDomainChildren,listDomains",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "user to security group mapping",
+ "length": 255,
+ "name": "usersecuritygrouplist",
+ "required": false,
+ "type": "map"
+ },
+ {
+ "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,
"name": "icmpcode",
"required": false,
"type": "integer"
- },
- {
- "description": "The ID of the security group. Mutually exclusive with securityGroupName parameter",
- "length": 255,
- "name": "securitygroupid",
- "related": "createSecurityGroup",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "the cidr list associated. Multiple entries must be separated by a single comma character (,).",
- "length": 255,
- "name": "cidrlist",
- "required": false,
- "type": "list"
}
],
"related": "",
@@ -88328,22 +89764,105 @@
"name": "account",
"type": "string"
},
- {},
{
- "description": "the ending IP of the security group rule ",
- "name": "endport",
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
"type": "integer"
},
{
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
"description": "the protocol of the security group rule",
"name": "protocol",
"type": "string"
},
{
+ "description": "security group name",
+ "name": "securitygroupname",
+ "type": "string"
+ },
+ {
+ "description": "the list of resource tags associated with the rule",
+ "name": "tags",
+ "response": [
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "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": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
"description": "the id of the security group rule",
"name": "ruleid",
"type": "string"
},
+ {},
+ {
+ "description": "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 CIDR notation for the base IP address of the security group rule",
"name": "cidr",
@@ -88353,89 +89872,6 @@
"description": "the type of the ICMP message response",
"name": "icmptype",
"type": "integer"
- },
- {},
- {
- "description": "security group name",
- "name": "securitygroupname",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "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 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": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "the 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": "resource type",
- "name": "resourcetype",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
}
]
},
@@ -88456,13 +89892,33 @@
"related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance",
"response": [
{
+ "description": "the name of the storage pool",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the host's currently allocated disk size",
+ "name": "disksizeallocated",
+ "type": "long"
+ },
+ {
+ "description": "the state of the storage pool",
+ "name": "state",
+ "type": "storagepoolstatus"
+ },
+ {
"description": "the overprovisionfactor for the storage pool",
"name": "overprovisionfactor",
"type": "string"
},
{
- "description": "total min IOPS currently in use by volumes",
- "name": "allocatediops",
+ "description": "the ID of the storage pool",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "IOPS CloudStack can provision from this storage pool",
+ "name": "capacityiops",
"type": "long"
},
{
@@ -88476,43 +89932,13 @@
"type": "integer"
},
{
- "description": "the Zone ID of the storage pool",
- "name": "zoneid",
+ "description": "the Pod ID of the storage pool",
+ "name": "podid",
"type": "string"
},
{
- "description": "the name of the storage pool",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the IP address of the storage pool",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "description": "the total disk size of the storage pool",
- "name": "disksizetotal",
- "type": "long"
- },
- {
- "description": "the name of the cluster for the storage pool",
- "name": "clustername",
- "type": "string"
- },
- {
- "description": "the Pod name of the storage pool",
- "name": "podname",
- "type": "string"
- },
- {
- "description": "the state of the storage pool",
- "name": "state",
- "type": "storagepoolstatus"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the storage pool type",
+ "name": "type",
"type": "string"
},
{},
@@ -88522,23 +89948,29 @@
"type": "date"
},
{
- "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",
- "type": "string"
- },
- {
"description": "true if the entity/resource has annotations",
"name": "hasannotations",
"type": "boolean"
},
{
- "description": "IOPS CloudStack can provision from this storage pool",
- "name": "capacityiops",
+ "description": "Storage provider for this pool",
+ "name": "provider",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "total min IOPS currently in use by volumes",
+ "name": "allocatediops",
+ "type": "long"
+ },
+ {
+ "description": "the tags for the storage pool",
+ "name": "tags",
+ "type": "string"
+ },
+ {
+ "description": "the total disk size of the storage pool",
+ "name": "disksizetotal",
"type": "long"
},
{
@@ -88547,55 +89979,59 @@
"type": "string"
},
{
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the scope of the storage pool",
+ "name": "scope",
+ "type": "string"
+ },
+ {
+ "description": "the IP address of the storage pool",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "the Zone name of the storage pool",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "the Zone ID of the storage pool",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
"description": "the host's currently used disk size",
"name": "disksizeused",
"type": "long"
},
{
- "description": "Storage provider for this pool",
- "name": "provider",
+ "description": "the Pod name of the storage pool",
+ "name": "podname",
"type": "string"
},
{
- "description": "the storage pool type",
- "name": "type",
+ "description": "the name of the cluster for the storage pool",
+ "name": "clustername",
"type": "string"
},
{
- "description": "the ID of the storage pool",
- "name": "id",
- "type": "string"
- },
- {
- "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 storage pool capabilities",
"name": "storagecapabilities",
"type": "map"
},
{
- "description": "the tags for the storage pool",
- "name": "tags",
- "type": "string"
- },
- {},
- {
- "description": "the Pod ID of the storage pool",
- "name": "podid",
+ "description": "the hypervisor type of the storage pool",
+ "name": "hypervisor",
"type": "string"
},
{
- "description": "the Zone name of the storage pool",
- "name": "zonename",
- "type": "string"
+ "description": "true if this pool is suitable to migrate a volume, false otherwise",
+ "name": "suitableformigration",
+ "type": "boolean"
}
],
"since": "4.15.1"
@@ -88606,13 +90042,6 @@
"name": "createSecurityGroup",
"params": [
{
- "description": "the description of the security group",
- "length": 255,
- "name": "description",
- "required": false,
- "type": "string"
- },
- {
"description": "name of the security group",
"length": 255,
"name": "name",
@@ -88620,46 +90049,62 @@
"type": "string"
},
{
- "description": "Create security group for project",
- "length": 255,
- "name": "projectid",
- "related": "activateProject,suspendProject",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "an optional account for the security group. Must be used with domainId.",
- "length": 255,
- "name": "account",
- "required": false,
- "type": "string"
- },
- {
"description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.",
"length": 255,
"name": "domainid",
"related": "listDomainChildren,listDomains",
"required": false,
"type": "uuid"
+ },
+ {
+ "description": "the description of the security group",
+ "length": 255,
+ "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"
+ },
+ {
+ "description": "Create security group for project",
+ "length": 255,
+ "name": "projectid",
+ "related": "activateProject,suspendProject",
+ "required": false,
+ "type": "uuid"
}
],
"related": "",
"response": [
{
- "description": "the list of virtualmachine ids associated with this securitygroup",
- "name": "virtualmachineids",
- "type": "set"
+ "description": "the number of virtualmachines associated with this securitygroup",
+ "name": "virtualmachinecount",
+ "type": "integer"
},
- {},
- {},
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
{
- "description": "the project id of the group",
- "name": "projectid",
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the domain ID of the security group",
+ "name": "domainid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the ID of the security group",
+ "name": "id",
"type": "string"
},
{
@@ -88672,62 +90117,22 @@
"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 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": "account owning the security group rule",
- "name": "account",
- "type": "string"
- },
- {
"description": "the list of resource tags associated with the rule",
"name": "tags",
"response": [
{
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "the 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": "tag value",
- "name": "value",
+ "description": "customer associated with the tag",
+ "name": "customer",
"type": "string"
},
{
@@ -88736,13 +90141,23 @@
"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": "resource type",
- "name": "resourcetype",
+ "description": "the project name where tag belongs to",
+ "name": "project",
"type": "string"
},
{
@@ -88751,16 +90166,21 @@
"type": "string"
},
{
- "description": "customer associated with the tag",
- "name": "customer",
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
"type": "string"
}
],
"type": "set"
},
{
- "description": "security group name",
- "name": "securitygroupname",
+ "description": "the protocol of the security group rule",
+ "name": "protocol",
"type": "string"
},
{
@@ -88769,31 +90189,57 @@
"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": "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": "security group name",
+ "name": "securitygroupname",
+ "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 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": "the account owning the security group",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the project id of the group",
+ "name": "projectid",
"type": "string"
},
{
@@ -88806,43 +90252,13 @@
"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 account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
"description": "tag value",
"name": "value",
"type": "string"
},
{
- "description": "id of the resource",
- "name": "resourceid",
+ "description": "customer associated with the tag",
+ "name": "customer",
"type": "string"
},
{
@@ -88854,45 +90270,45 @@
"description": "resource type",
"name": "resourcetype",
"type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
}
],
"type": "set"
},
{
- "description": "the account owning the security group",
- "name": "account",
- "type": "string"
- },
- {
"description": "the list of ingress rules associated with the security group",
"name": "ingressrule",
"response": [
{
- "description": "the CIDR notation for the base IP address of the security group rule",
- "name": "cidr",
- "type": "string"
- },
- {
- "description": "security group name",
- "name": "securitygroupname",
- "type": "string"
- },
- {
- "description": "the starting IP of the security group rule",
- "name": "startport",
- "type": "integer"
- },
- {
- "description": "the id of the security group rule",
- "name": "ruleid",
- "type": "string"
- },
- {
- "description": "account owning the security group rule",
- "name": "account",
- "type": "string"
- },
- {
"description": "the protocol of the security group rule",
"name": "protocol",
"type": "string"
@@ -88903,8 +90319,18 @@
"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 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"
},
{
@@ -88912,6 +90338,31 @@
"name": "tags",
"response": [
{
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
"description": "customer associated with the tag",
"name": "customer",
"type": "string"
@@ -88922,28 +90373,8 @@
"type": "string"
},
{
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "tag 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",
+ "description": "the domain associated with the tag",
+ "name": "domain",
"type": "string"
},
{
@@ -88952,34 +90383,39 @@
"type": "string"
},
{
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
+ "description": "tag value",
+ "name": "value",
"type": "string"
}
],
"type": "set"
},
{
- "description": "the code for the ICMP message response",
- "name": "icmpcode",
+ "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 ending IP of the security group rule ",
+ "name": "endport",
"type": "integer"
}
],
"type": "set"
},
{
- "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 name of the security group",
+ "name": "name",
"type": "string"
}
]
@@ -89023,28 +90459,18 @@
"related": "",
"response": [
{
- "description": "resource count",
- "name": "resourcecount",
- "type": "long"
- },
- {
"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 for which resource count's are updated",
- "name": "account",
+ "description": "the project id for which resource count's are updated",
+ "name": "projectid",
"type": "string"
},
{
- "description": "resource type. Values include 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values.",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "the domain ID for which resource count's are updated",
- "name": "domainid",
+ "description": "the project name for which resource count's are updated",
+ "name": "project",
"type": "string"
},
{
@@ -89053,25 +90479,35 @@
"type": "string"
},
{},
- {},
{
- "description": "the project name for which resource count's are updated",
- "name": "project",
+ "description": "the domain ID for which resource count's are updated",
+ "name": "domainid",
"type": "string"
},
{
+ "description": "the account for which resource count's are updated",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "resource count",
+ "name": "resourcecount",
+ "type": "long"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {},
+ {
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
{
- "description": "the project id for which resource count's are updated",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "resource type. Values include 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values.",
+ "name": "resourcetype",
"type": "string"
}
]
@@ -89082,6 +90518,28 @@
"name": "listVpnGateways",
"params": [
{
+ "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
+ "length": 255,
+ "name": "isrecursive",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "list 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",
+ "length": 255,
+ "name": "domainid",
+ "related": "listDomainChildren,listDomains",
+ "required": false,
+ "type": "uuid"
+ },
+ {
"description": "list objects by project",
"length": 255,
"name": "projectid",
@@ -89097,33 +90555,18 @@
"type": "boolean"
},
{
- "description": "",
+ "description": "List by keyword",
"length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
- },
- {
- "description": "list resources by account. Must be used with the domainId parameter.",
- "length": 255,
- "name": "account",
+ "name": "keyword",
"required": false,
"type": "string"
},
{
- "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
+ "description": "",
"length": 255,
- "name": "isrecursive",
+ "name": "page",
"required": false,
- "type": "boolean"
- },
- {
- "description": "id of the vpn gateway",
- "length": 255,
- "name": "id",
- "related": "createVpnGateway,listVpnGateways",
- "required": false,
- "type": "uuid"
+ "type": "integer"
},
{
"description": "id of vpc",
@@ -89134,53 +90577,34 @@
"type": "uuid"
},
{
+ "description": "id of the vpn gateway",
+ "length": 255,
+ "name": "id",
+ "related": "createVpnGateway,listVpnGateways",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
"description": "list resources by display flag; only ROOT admin is eligible to pass this parameter",
"length": 255,
"name": "fordisplay",
"required": false,
"since": "4.4",
"type": "boolean"
- },
- {
- "description": "",
- "length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
- },
- {
- "description": "list only resources belonging to the domain specified",
- "length": 255,
- "name": "domainid",
- "related": "listDomainChildren,listDomains",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
}
],
"related": "createVpnGateway",
"response": [
- {},
- {},
{
- "description": "the project name",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the domain id of the owner",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the vpn gateway ID",
- "name": "id",
+ "description": "the public IP address",
+ "name": "publicip",
"type": "string"
},
{
@@ -89189,49 +90613,61 @@
"type": "boolean"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the owner",
- "name": "account",
- "type": "string"
- },
- {
"description": "the project id",
"name": "projectid",
"type": "string"
},
{
- "description": "the public IP address",
- "name": "publicip",
- "type": "string"
- },
- {
- "description": "the vpc name of this gateway",
- "name": "vpcname",
- "type": "string"
+ "description": "the date and time the host was removed",
+ "name": "removed",
+ "type": "date"
},
{
"description": "the domain name of the owner",
"name": "domain",
"type": "string"
},
+ {},
{
"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",
+ "type": "string"
+ },
+ {
+ "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 date and time the host was removed",
- "name": "removed",
- "type": "date"
+ "description": "the owner",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the domain id of the owner",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the vpc name of this gateway",
+ "name": "vpcname",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the project name",
+ "name": "project",
+ "type": "string"
}
]
},
@@ -89248,6 +90684,13 @@
"type": "string"
},
{
+ "description": "List role by role type, valid options are: Admin, ResourceAdmin, DomainAdmin, User.",
+ "length": 255,
+ "name": "type",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "List role by role ID.",
"length": 255,
"name": "id",
@@ -89258,7 +90701,7 @@
{
"description": "",
"length": 255,
- "name": "page",
+ "name": "pagesize",
"required": false,
"type": "integer"
},
@@ -89270,16 +90713,9 @@
"type": "string"
},
{
- "description": "List role by role type, valid options are: Admin, ResourceAdmin, DomainAdmin, User.",
- "length": 255,
- "name": "type",
- "required": false,
- "type": "string"
- },
- {
"description": "",
"length": 255,
- "name": "pagesize",
+ "name": "page",
"required": false,
"type": "integer"
}
@@ -89287,8 +90723,8 @@
"related": "importRole",
"response": [
{
- "description": "the type of the role",
- "name": "type",
+ "description": "the name of the role",
+ "name": "name",
"type": "string"
},
{
@@ -89296,23 +90732,8 @@
"name": "jobid",
"type": "string"
},
- {
- "description": "the name of the role",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the description of the role",
- "name": "description",
- "type": "string"
- },
{},
{
- "description": "true if role 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"
@@ -89322,7 +90743,22 @@
"name": "id",
"type": "string"
},
- {}
+ {},
+ {
+ "description": "true if role is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {
+ "description": "the type of the role",
+ "name": "type",
+ "type": "string"
+ },
+ {
+ "description": "the description of the role",
+ "name": "description",
+ "type": "string"
+ }
],
"since": "4.9.0"
},
@@ -89342,12 +90778,6 @@
],
"related": "",
"response": [
- {
- "description": "the cloud identifier",
- "name": "cloudidentifier",
- "type": "string"
- },
- {},
{},
{
"description": "the signed response for the cloud identifier",
@@ -89360,6 +90790,11 @@
"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"
@@ -89368,7 +90803,8 @@
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
- }
+ },
+ {}
]
},
{
@@ -89377,22 +90813,6 @@
"name": "createLBStickinessPolicy",
"params": [
{
- "description": "an optional field, whether to the display the rule to the end user or not",
- "length": 255,
- "name": "fordisplay",
- "required": false,
- "since": "4.4",
- "type": "boolean"
- },
- {
- "description": "the ID of the load balancer rule",
- "length": 255,
- "name": "lbruleid",
- "related": "",
- "required": true,
- "type": "uuid"
- },
- {
"description": "name of the load balancer stickiness policy",
"length": 255,
"name": "name",
@@ -89407,11 +90827,12 @@
"type": "string"
},
{
- "description": "param list. Example: param[0].name=cookiename¶m[0].value=LBCookie ",
+ "description": "the ID of the load balancer rule",
"length": 255,
- "name": "param",
- "required": false,
- "type": "map"
+ "name": "lbruleid",
+ "related": "",
+ "required": true,
+ "type": "uuid"
},
{
"description": "name of the load balancer stickiness policy method, possible values can be obtained from listNetworks API",
@@ -89419,25 +90840,33 @@
"name": "methodname",
"required": true,
"type": "string"
+ },
+ {
+ "description": "param list. Example: param[0].name=cookiename¶m[0].value=LBCookie ",
+ "length": 255,
+ "name": "param",
+ "required": false,
+ "type": "map"
+ },
+ {
+ "description": "an optional field, whether to the display the rule to the end user or not",
+ "length": 255,
+ "name": "fordisplay",
+ "required": false,
+ "since": "4.4",
+ "type": "boolean"
}
],
"related": "listLBStickinessPolicies",
"response": [
{
- "description": "the domain of the Stickiness policy",
- "name": "domain",
- "type": "string"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
{
- "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",
+ "description": "the name of the Stickiness policy",
+ "name": "name",
"type": "string"
},
{
@@ -89445,18 +90874,18 @@
"name": "stickinesspolicy",
"response": [
{
- "description": "the state of the policy",
- "name": "state",
- "type": "string"
+ "description": "the params of the policy",
+ "name": "params",
+ "type": "map"
},
{
- "description": "the LB Stickiness policy ID",
- "name": "id",
- "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",
+ "description": "the name of the Stickiness policy",
+ "name": "name",
"type": "string"
},
{
@@ -89465,46 +90894,53 @@
"type": "string"
},
{
- "description": "the params of the policy",
- "name": "params",
- "type": "map"
- },
- {
- "description": "the name of the Stickiness policy",
- "name": "name",
+ "description": "the method name of the Stickiness policy",
+ "name": "methodname",
"type": "string"
},
{
- "description": "is policy for display to the regular user",
- "name": "fordisplay",
- "type": "boolean"
+ "description": "the LB Stickiness policy ID",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the state of the policy",
+ "name": "state",
+ "type": "string"
}
],
"type": "list"
},
+ {},
+ {
+ "description": "the LB rule ID",
+ "name": "lbruleid",
+ "type": "string"
+ },
{
"description": "the state of the policy",
"name": "state",
"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 account of the Stickiness policy",
"name": "account",
"type": "string"
},
{
- "description": "the description of the Stickiness policy",
- "name": "description",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the LB rule ID",
- "name": "lbruleid",
+ "description": "the domain ID of the Stickiness policy",
+ "name": "domainid",
"type": "string"
},
{
@@ -89513,8 +90949,8 @@
"type": "string"
},
{
- "description": "the name of the Stickiness policy",
- "name": "name",
+ "description": "the description of the Stickiness policy",
+ "name": "description",
"type": "string"
}
],
@@ -89526,13 +90962,6 @@
"name": "addCiscoAsa1000vResource",
"params": [
{
- "description": "Nexus port profile associated with inside interface of ASA 1000v",
- "length": 255,
- "name": "insideportprofile",
- "required": true,
- "type": "string"
- },
- {
"description": "the Cluster ID",
"length": 255,
"name": "clusterid",
@@ -89541,6 +90970,13 @@
"type": "uuid"
},
{
+ "description": "Nexus port profile associated with inside interface of ASA 1000v",
+ "length": 255,
+ "name": "insideportprofile",
+ "required": true,
+ "type": "string"
+ },
+ {
"description": "Hostname or ip address of the Cisco ASA 1000v appliance.",
"length": 255,
"name": "hostname",
@@ -89562,14 +90998,14 @@
{},
{},
{},
+ {},
+ {},
+ {},
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
- {},
- {},
- {},
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
@@ -89583,43 +91019,32 @@
"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,
"name": "fwdeviceid",
"related": "addPaloAltoFirewall,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": "addPaloAltoFirewall,listPaloAltoFirewalls",
"response": [
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the usage interface of the external firewall",
+ "name": "usageinterface",
"type": "string"
},
{
- "description": "the timeout (in seconds) for requests to the external firewall",
- "name": "timeout",
- "type": "string"
- },
- {
- "description": "the zone ID of the external firewall",
- "name": "zoneid",
- "type": "string"
- },
- {},
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "device capacity",
+ "name": "fwdevicecapacity",
+ "type": "long"
},
{
"description": "name of the provider",
@@ -89627,70 +91052,81 @@
"type": "string"
},
{
- "description": "device id of the Palo Alto firewall",
- "name": "fwdeviceid",
- "type": "string"
- },
- {
- "description": "the public security zone of the external firewall",
- "name": "publiczone",
- "type": "string"
- },
- {
- "description": "device name",
- "name": "fwdevicename",
- "type": "string"
- },
- {
"description": "the username that's used to log in to the external firewall",
"name": "username",
"type": "string"
},
- {},
{
"description": "the private security zone of the external firewall",
"name": "privatezone",
"type": "string"
},
{
- "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",
- "type": "string"
- },
- {
"description": "the public interface of the external firewall",
"name": "publicinterface",
"type": "string"
},
{
- "description": "the usage interface of the external firewall",
- "name": "usageinterface",
- "type": "string"
- },
- {
- "description": "the private interface of the external firewall",
- "name": "privateinterface",
- "type": "string"
- },
- {
"description": "the management IP address of the external firewall",
"name": "ipaddress",
"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 Palo Alto firewall belongs to",
+ "name": "physicalnetworkid",
+ "type": "string"
+ },
+ {
"description": "device state",
"name": "fwdevicestate",
"type": "string"
},
+ {},
{
- "description": "device capacity",
- "name": "fwdevicecapacity",
- "type": "long"
+ "description": "device name",
+ "name": "fwdevicename",
+ "type": "string"
+ },
+ {
+ "description": "the timeout (in seconds) for requests to the external firewall",
+ "name": "timeout",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the public security zone of the external firewall",
+ "name": "publiczone",
+ "type": "string"
+ },
+ {
+ "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 zone ID of the external firewall",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "device id of the Palo Alto firewall",
+ "name": "fwdeviceid",
+ "type": "string"
}
]
},
@@ -89700,9 +91136,9 @@
"name": "updateNetworkACLItem",
"params": [
{
- "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"
},
@@ -89715,6 +91151,13 @@
"type": "boolean"
},
{
+ "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"
+ },
+ {
"description": "the ending port of ACL",
"length": 255,
"name": "endport",
@@ -89722,20 +91165,6 @@
"type": "integer"
},
{
- "description": "Indicates if the ACL rule is to be updated partially (merging the parameters sent with current configuration) or completely (disconsidering all of the current configurations). The default value is 'true'.",
- "length": 255,
- "name": "partialupgrade",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "error code for this ICMP message",
- "length": 255,
- "name": "icmpcode",
- "required": false,
- "type": "integer"
- },
- {
"description": "The network of the vm the ACL will be created for",
"length": 255,
"name": "number",
@@ -89743,13 +91172,6 @@
"type": "integer"
},
{
- "description": "the starting port of ACL",
- "length": 255,
- "name": "startport",
- "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",
"length": 255,
"name": "customid",
@@ -89765,6 +91187,14 @@
"type": "list"
},
{
+ "description": "the ID of the network ACL item",
+ "length": 255,
+ "name": "id",
+ "related": "updateNetworkACLItem,moveNetworkAclItem",
+ "required": true,
+ "type": "uuid"
+ },
+ {
"description": "type of the ICMP message being sent",
"length": 255,
"name": "icmptype",
@@ -89772,6 +91202,20 @@
"type": "integer"
},
{
+ "description": "scl entry action, allow or deny",
+ "length": 255,
+ "name": "action",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "error code for this ICMP message",
+ "length": 255,
+ "name": "icmpcode",
+ "required": false,
+ "type": "integer"
+ },
+ {
"description": "the traffic type for the ACL, can be Ingress or Egress, defaulted to Ingress if not specified",
"length": 255,
"name": "traffictype",
@@ -89779,48 +91223,31 @@
"type": "string"
},
{
- "description": "the ID of the network ACL item",
+ "description": "the starting port of ACL",
"length": 255,
- "name": "id",
- "related": "updateNetworkACLItem,moveNetworkAclItem",
- "required": true,
- "type": "uuid"
+ "name": "startport",
+ "required": false,
+ "type": "integer"
},
{
- "description": "A description indicating why the ACL rule is required.",
+ "description": "Indicates if the ACL rule is to be updated partially (merging the parameters sent with current configuration) or completely (disconsidering all of the current configurations). The default value is 'true'.",
"length": 255,
- "name": "reason",
+ "name": "partialupgrade",
"required": false,
- "type": "string"
- },
- {
- "description": "scl entry action, allow or deny",
- "length": 255,
- "name": "action",
- "required": false,
- "type": "string"
+ "type": "boolean"
}
],
"related": "moveNetworkAclItem",
"response": [
+ {},
{
- "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": "type of the icmp message being sent",
- "name": "icmptype",
+ "description": "error code for this icmp message",
+ "name": "icmpcode",
"type": "integer"
},
{
- "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"
},
{
@@ -89829,43 +91256,27 @@
"type": "integer"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
+ "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 ID of the ACL Item",
- "name": "id",
+ "description": "the traffic type for the ACL",
+ "name": "traffictype",
"type": "string"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "error code for this icmp message",
- "name": "icmpcode",
- "type": "integer"
- },
- {
"description": "the protocol of the ACL",
"name": "protocol",
"type": "string"
},
{
- "description": "Action of ACL Item. Allow/Deny",
- "name": "action",
- "type": "string"
- },
- {
- "description": "the ending port of ACL's port range",
- "name": "endport",
- "type": "string"
- },
- {},
- {
"description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).",
"name": "cidrlist",
"type": "string"
@@ -89876,13 +91287,33 @@
"type": "string"
},
{
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the ID of the ACL Item",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the name of the ACL this item belongs to",
+ "name": "aclname",
+ "type": "string"
+ },
+ {
+ "description": "the ending port of ACL's port range",
+ "name": "endport",
+ "type": "string"
+ },
+ {
"description": "an explanation on why this ACL rule is being applied",
"name": "reason",
"type": "string"
},
{
- "description": "the traffic type for the ACL",
- "name": "traffictype",
+ "description": "the starting port of ACL's port range",
+ "name": "startport",
"type": "string"
},
{
@@ -89895,23 +91326,8 @@
"name": "tags",
"response": [
{
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
+ "description": "customer associated with the tag",
+ "name": "customer",
"type": "string"
},
{
@@ -89920,32 +91336,52 @@
"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 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": "id of the resource",
"name": "resourceid",
"type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
}
],
"type": "list"
+ },
+ {
+ "description": "Action of ACL Item. Allow/Deny",
+ "name": "action",
+ "type": "string"
}
]
},
@@ -89981,8 +91417,14 @@
"response": [
{},
{
- "description": "any text associated with the success or failure",
- "name": "displaytext",
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {},
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
@@ -89991,16 +91433,10 @@
"type": "boolean"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "any text associated with the success or failure",
+ "name": "displaytext",
"type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {}
+ }
],
"since": "4.11"
},
@@ -90010,6 +91446,14 @@
"name": "listRouters",
"params": [
{
+ "description": "the Zone ID of the router",
+ "length": 255,
+ "name": "zoneid",
+ "related": "createZone,listZones",
+ "required": false,
+ "type": "uuid"
+ },
+ {
"description": "List by keyword",
"length": 255,
"name": "keyword",
@@ -90025,6 +91469,14 @@
"type": "boolean"
},
{
+ "description": "the cluster ID of the router",
+ "length": 255,
+ "name": "clusterid",
+ "related": "addCluster",
+ "required": false,
+ "type": "uuid"
+ },
+ {
"description": "",
"length": 255,
"name": "pagesize",
@@ -90032,20 +91484,6 @@
"type": "integer"
},
{
- "description": "the state of the router",
- "length": 255,
- "name": "state",
- "required": false,
- "type": "string"
- },
- {
- "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
- "length": 255,
- "name": "isrecursive",
- "required": false,
- "type": "boolean"
- },
- {
"description": "if this parameter is passed, list only routers by health check results",
"length": 255,
"name": "healthchecksfailed",
@@ -90054,21 +91492,13 @@
"type": "boolean"
},
{
- "description": "list resources by account. Must be used with the domainId parameter.",
+ "description": "the state of the router",
"length": 255,
- "name": "account",
+ "name": "state",
"required": false,
"type": "string"
},
{
- "description": "the cluster ID of the router",
- "length": 255,
- "name": "clusterid",
- "related": "addCluster",
- "required": false,
- "type": "uuid"
- },
- {
"description": "list objects by project",
"length": 255,
"name": "projectid",
@@ -90077,13 +91507,51 @@
"type": "uuid"
},
{
- "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false",
+ "description": "the host ID of the router",
"length": 255,
- "name": "listall",
+ "name": "hostid",
+ "related": "reconnectHost,addBaremetalHost",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "List networks by VPC",
+ "length": 255,
+ "name": "vpcid",
+ "related": "createVPC,listVPCs,updateVPC",
+ "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 true is passed for this parameter, list only VPC routers",
+ "length": 255,
+ "name": "forvpc",
"required": false,
"type": "boolean"
},
{
+ "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
+ "length": 255,
+ "name": "isrecursive",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "the Pod ID of the router",
+ "length": 255,
+ "name": "podid",
+ "related": "updatePod,createManagementNetworkIpRange",
+ "required": false,
+ "type": "uuid"
+ },
+ {
"description": "",
"length": 255,
"name": "page",
@@ -90091,30 +91559,6 @@
"type": "integer"
},
{
- "description": "list by network id",
- "length": 255,
- "name": "networkid",
- "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listBrocadeVcsDeviceNetworks",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "the Zone ID of the router",
- "length": 255,
- "name": "zoneid",
- "related": "createZone,listZones",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "the ID of the disk router",
- "length": 255,
- "name": "id",
- "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance",
- "required": false,
- "type": "uuid"
- },
- {
"description": "the name of the router",
"length": 255,
"name": "name",
@@ -90122,10 +91566,10 @@
"type": "string"
},
{
- "description": "the Pod ID of the router",
+ "description": "the ID of the disk router",
"length": 255,
- "name": "podid",
- "related": "updatePod,createManagementNetworkIpRange",
+ "name": "id",
+ "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance",
"required": false,
"type": "uuid"
},
@@ -90137,10 +91581,17 @@
"type": "string"
},
{
- "description": "List networks by 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",
"length": 255,
- "name": "vpcid",
- "related": "createVPC,listVPCs,updateVPC",
+ "name": "listall",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "list by network id",
+ "length": 255,
+ "name": "networkid",
+ "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listBrocadeVcsDeviceNetworks",
"required": false,
"type": "uuid"
},
@@ -90151,397 +91602,23 @@
"related": "listDomainChildren,listDomains",
"required": false,
"type": "uuid"
- },
- {
- "description": "if true is passed for this parameter, list only VPC routers",
- "length": 255,
- "name": "forvpc",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "the host ID of the router",
- "length": 255,
- "name": "hostid",
- "related": "reconnectHost,addBaremetalHost",
- "required": false,
- "type": "uuid"
}
],
"related": "destroyRouter",
"response": [
{
- "description": "the ID of the corresponding public network",
- "name": "publicnetworkid",
- "type": "string"
- },
- {
- "description": "the template ID for the router",
- "name": "templateid",
- "type": "string"
- },
- {
- "description": "the template name for the router",
- "name": "templatename",
- "type": "string"
- },
- {
- "description": "the state of redundant virtual router",
- "name": "redundantstate",
- "type": "string"
- },
- {
- "description": "the guest IP address for the router",
- "name": "guestipaddress",
- "type": "string"
- },
- {
- "description": "the account associated with the router",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the first IPv6 DNS for the router",
- "name": "ip6dns1",
- "type": "string"
- },
- {},
- {
- "description": "the domain ID associated with the router",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the Pod name for the router",
- "name": "podname",
- "type": "string"
- },
- {
- "description": "true if the router template requires upgrader",
- "name": "requiresupgrade",
- "type": "boolean"
- },
- {
- "description": "the link local MAC address for the router",
- "name": "linklocalmacaddress",
- "type": "string"
- },
- {
- "description": "the ID of the service offering of the virtual machine",
- "name": "serviceofferingid",
- "type": "string"
- },
- {
- "description": "the gateway for the router",
- "name": "gateway",
- "type": "string"
- },
- {
- "description": "the network domain for the router",
- "name": "networkdomain",
- "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 ID of the corresponding link local network",
- "name": "linklocalnetworkid",
- "type": "string"
- },
- {},
- {
- "description": "true if any health checks had failed",
- "name": "healthchecksfailed",
- "type": "boolean"
- },
- {
- "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 Pod ID for the router",
- "name": "podid",
- "type": "string"
- },
- {
- "description": "the name of the corresponding guest network",
- "name": "guestnetworkname",
- "type": "string"
- },
- {
- "description": "the host ID for the router",
- "name": "hostid",
- "type": "string"
- },
- {
- "description": "the guest MAC address for the router",
- "name": "guestmacaddress",
- "type": "string"
- },
- {
- "description": "the state of the router",
- "name": "state",
- "type": "state"
- },
- {
- "description": "the id of the router",
- "name": "id",
- "type": "string"
- },
- {
"description": "the link local IP address for the router",
"name": "linklocalip",
"type": "string"
},
{
- "description": "the hypervisor on which the template runs",
- "name": "hypervisor",
- "type": "string"
- },
- {
- "description": "the Zone name for the router",
- "name": "zonename",
- "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 link local netmask for the router",
- "name": "linklocalnetmask",
- "type": "string"
- },
- {
- "description": "the hostname for the router",
- "name": "hostname",
- "type": "string"
- },
- {
- "description": "if this router is an redundant virtual router",
- "name": "isredundantrouter",
- "type": "boolean"
- },
- {
- "description": "the ID of the corresponding guest network",
- "name": "guestnetworkid",
- "type": "string"
- },
- {
- "description": "role of the domain router",
- "name": "role",
- "type": "string"
- },
- {
- "description": "the name of the router",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the public IP address for the router",
- "name": "publicip",
- "type": "string"
- },
- {
- "description": "the public netmask for the router",
- "name": "publicnetmask",
- "type": "string"
- },
- {
- "description": "the version of scripts",
- "name": "scriptsversion",
- "type": "string"
- },
- {
- "description": "the guest netmask for the router",
- "name": "guestnetmask",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the domain associated with the router",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the second DNS for the router",
- "name": "dns2",
- "type": "string"
- },
- {
"description": "VPC the router belongs to",
"name": "vpcid",
"type": "string"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the list of nics associated with the router",
- "name": "nic",
- "response": [
- {
- "description": "the name of the corresponding network",
- "name": "networkname",
- "type": "string"
- },
- {
- "description": "the traffic type of the nic",
- "name": "traffictype",
- "type": "string"
- },
- {
- "description": "the ID of the corresponding network",
- "name": "networkid",
- "type": "string"
- },
- {
- "description": "the netmask of the nic",
- "name": "netmask",
- "type": "string"
- },
- {
- "description": "the Secondary ipv4 addr of nic",
- "name": "secondaryip",
- "type": "list"
- },
- {
- "description": "the ID of the nic",
- "name": "id",
- "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": "Id of the NSX Logical Switch (if NSX based), null otherwise",
- "name": "nsxlogicalswitch",
- "type": "string"
- },
- {
- "description": "true if nic is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
- },
- {
- "description": "the type of the nic",
- "name": "type",
- "type": "string"
- },
- {
- "description": "the gateway of IPv6 network",
- "name": "ip6gateway",
- "type": "string"
- },
- {
- "description": "the isolated private VLAN if available",
- "name": "isolatedpvlan",
- "type": "integer"
- },
- {
- "description": "device id for the network when plugged into the virtual machine",
- "name": "deviceid",
- "type": "string"
- },
- {
- "description": "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": "the ip address of the nic",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "description": "the isolation uri of the nic",
- "name": "isolationuri",
- "type": "string"
- },
- {
- "description": "the cidr of IPv6 network",
- "name": "ip6cidr",
- "type": "string"
- },
- {
- "description": "Type of adapter if available",
- "name": "adaptertype",
- "type": "string"
- },
- {
- "description": "true if nic is default, false otherwise",
- "name": "macaddress",
- "type": "string"
- },
- {
- "description": "Id of the vm to which the nic belongs",
- "name": "virtualmachineid",
- "type": "string"
- },
- {
- "description": "the broadcast uri of the nic",
- "name": "broadcasturi",
- "type": "string"
- },
- {
- "description": "the gateway of the nic",
- "name": "gateway",
- "type": "string"
- },
- {
- "description": "the IPv6 address of network",
- "name": "ip6address",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the second IPv6 DNS for the router",
- "name": "ip6dns2",
+ "description": "the name of the corresponding guest network",
+ "name": "guestnetworkname",
"type": "string"
},
{
@@ -90577,13 +91654,357 @@
"type": "list"
},
{
+ "description": "the Pod name for the router",
+ "name": "podname",
+ "type": "string"
+ },
+ {
+ "description": "the state of redundant virtual router",
+ "name": "redundantstate",
+ "type": "string"
+ },
+ {
+ "description": "the first DNS for the router",
+ "name": "dns1",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the address",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the Zone ID for the router",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the name of VPC the router belongs to",
+ "name": "vpcname",
+ "type": "string"
+ },
+ {
+ "description": "the id of the router",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "if this router is an redundant virtual router",
+ "name": "isredundantrouter",
+ "type": "boolean"
+ },
+ {
+ "description": "true if any health checks had failed",
+ "name": "healthchecksfailed",
+ "type": "boolean"
+ },
+ {
+ "description": "the 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 corresponding public network",
+ "name": "publicnetworkid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the corresponding guest network",
+ "name": "guestnetworkid",
+ "type": "string"
+ },
+ {
+ "description": "the public netmask for the router",
+ "name": "publicnetmask",
+ "type": "string"
+ },
+ {
+ "description": "the name of the router",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "role of the domain router",
+ "name": "role",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID associated with the router",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the template ID for the router",
+ "name": "templateid",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the router",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the link local netmask for the router",
+ "name": "linklocalnetmask",
+ "type": "string"
+ },
+ {
+ "description": "the list of nics associated with the router",
+ "name": "nic",
+ "response": [
+ {
+ "description": "Id of the vm to which the nic belongs",
+ "name": "virtualmachineid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the corresponding network",
+ "name": "networkname",
+ "type": "string"
+ },
+ {
+ "description": "the isolated private VLAN type if available",
+ "name": "isolatedpvlantype",
+ "type": "string"
+ },
+ {
+ "description": "the netmask of the nic",
+ "name": "netmask",
+ "type": "string"
+ },
+ {
+ "description": "the traffic type of the nic",
+ "name": "traffictype",
+ "type": "string"
+ },
+ {
+ "description": "the isolated private VLAN if available",
+ "name": "isolatedpvlan",
+ "type": "integer"
+ },
+ {
+ "description": "the gateway of IPv6 network",
+ "name": "ip6gateway",
+ "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": "Type of adapter if available",
+ "name": "adaptertype",
+ "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": "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": "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 broadcast uri of the nic",
+ "name": "broadcasturi",
+ "type": "string"
+ },
+ {
+ "description": "true if nic is default, false otherwise",
+ "name": "macaddress",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the nic",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the corresponding network",
+ "name": "networkid",
+ "type": "string"
+ },
+ {
+ "description": "the cidr of IPv6 network",
+ "name": "ip6cidr",
+ "type": "string"
+ },
+ {
+ "description": "the gateway of the nic",
+ "name": "gateway",
+ "type": "string"
+ },
+ {
+ "description": "IP addresses associated with NIC found for unmanaged VM",
+ "name": "ipaddresses",
+ "type": "list"
+ },
+ {
+ "description": "the type of the nic",
+ "name": "type",
+ "type": "string"
+ },
+ {
+ "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise",
+ "name": "nsxlogicalswitchport",
+ "type": "string"
+ },
+ {
+ "description": "the ip address of the nic",
+ "name": "ipaddress",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the version of scripts",
+ "name": "scriptsversion",
+ "type": "string"
+ },
+ {
+ "description": "true if the router template requires upgrader",
+ "name": "requiresupgrade",
+ "type": "boolean"
+ },
+ {},
+ {
+ "description": "the project id of the ipaddress",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the router",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the link local MAC address for the router",
+ "name": "linklocalmacaddress",
+ "type": "string"
+ },
+ {
+ "description": "the guest netmask for the router",
+ "name": "guestnetmask",
+ "type": "string"
+ },
+ {
+ "description": "the host ID for the router",
+ "name": "hostid",
+ "type": "string"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the public IP address for the router",
+ "name": "publicip",
+ "type": "string"
+ },
+ {
"description": "the date and time the router was created",
"name": "created",
"type": "date"
},
{
- "description": "the first DNS for the router",
- "name": "dns1",
+ "description": "the ID of the service offering of the virtual machine",
+ "name": "serviceofferingid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the guest MAC address for the router",
+ "name": "guestmacaddress",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the corresponding link local network",
+ "name": "linklocalnetworkid",
+ "type": "string"
+ },
+ {
+ "description": "the second IPv6 DNS for the router",
+ "name": "ip6dns2",
+ "type": "string"
+ },
+ {
+ "description": "the state of the router",
+ "name": "state",
+ "type": "state"
+ },
+ {
+ "description": "the Pod ID for the router",
+ "name": "podid",
+ "type": "string"
+ },
+ {
+ "description": "the 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": "the network domain for the router",
+ "name": "networkdomain",
+ "type": "string"
+ },
+ {
+ "description": "the gateway for the router",
+ "name": "gateway",
+ "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"
},
{
@@ -90592,9 +92013,24 @@
"type": "string"
},
{
+ "description": "the template name for the router",
+ "name": "templatename",
+ "type": "string"
+ },
+ {
"description": "the version of template",
"name": "version",
"type": "string"
+ },
+ {
+ "description": "the hostname for the router",
+ "name": "hostname",
+ "type": "string"
+ },
+ {
+ "description": "the name of the service offering of the virtual machine",
+ "name": "serviceofferingname",
+ "type": "string"
}
]
},
@@ -90613,27 +92049,27 @@
}
],
"response": [
- {},
- {
- "description": "any text associated with the success or failure",
- "name": "displaytext",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
{
"description": "true if operation is executed successfully",
"name": "success",
"type": "boolean"
},
{
+ "description": "any text associated with the success or failure",
+ "name": "displaytext",
+ "type": "string"
+ },
+ {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
+ {},
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
{}
]
},
@@ -90643,20 +92079,11 @@
"name": "createVpnConnection",
"params": [
{
- "description": "id of the vpn gateway",
+ "description": "connection is passive or not",
"length": 255,
- "name": "s2svpngatewayid",
- "related": "createVpnGateway",
- "required": true,
- "type": "uuid"
- },
- {
- "description": "id of the customer gateway",
- "length": 255,
- "name": "s2scustomergatewayid",
- "related": "createVpnCustomerGateway",
- "required": true,
- "type": "uuid"
+ "name": "passive",
+ "required": false,
+ "type": "boolean"
},
{
"description": "an optional field, whether to the display the vpn to the end user or not",
@@ -90667,85 +92094,83 @@
"type": "boolean"
},
{
- "description": "connection is passive or not",
+ "description": "id of the customer gateway",
"length": 255,
- "name": "passive",
- "required": false,
- "type": "boolean"
+ "name": "s2scustomergatewayid",
+ "related": "createVpnCustomerGateway",
+ "required": true,
+ "type": "uuid"
+ },
+ {
+ "description": "id of the vpn gateway",
+ "length": 255,
+ "name": "s2svpngatewayid",
+ "related": "createVpnGateway",
+ "required": true,
+ "type": "uuid"
}
],
"related": "",
"response": [
{
- "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": "state",
- "type": "string"
- },
- {
- "description": "public ip address id of the customer gateway",
- "name": "gateway",
- "type": "string"
- },
- {
- "description": "the project id",
- "name": "projectid",
- "type": "string"
- },
- {},
- {
"description": "Lifetime of ESP SA of customer gateway",
"name": "esplifetime",
"type": "long"
},
{
+ "description": "IKE policy of the customer gateway",
+ "name": "ikepolicy",
+ "type": "string"
+ },
+ {
+ "description": "the date and time the host was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).",
+ "name": "cidrlist",
+ "type": "string"
+ },
+ {},
+ {
"description": "if Force NAT Encapsulation is enabled for customer gateway",
"name": "forceencap",
"type": "boolean"
},
{
- "description": "the date and time the host was removed",
- "name": "removed",
- "type": "date"
- },
- {
- "description": "IPsec Preshared-Key of the customer gateway",
- "name": "ipsecpsk",
- "type": "string"
- },
- {
- "description": "State of vpn connection",
- "name": "passive",
- "type": "boolean"
- },
- {
- "description": "the domain id of the owner",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the domain name of the owner",
- "name": "domain",
- "type": "string"
- },
- {
"description": "the customer gateway ID",
"name": "s2scustomergatewayid",
"type": "string"
},
{
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
"description": "the public IP address",
"name": "publicip",
"type": "string"
},
{
- "description": "ESP policy of the customer gateway",
- "name": "esppolicy",
+ "description": "IPsec Preshared-Key of the customer gateway",
+ "name": "ipsecpsk",
+ "type": "string"
+ },
+ {
+ "description": "the date and time the host was removed",
+ "name": "removed",
+ "type": "date"
+ },
+ {
+ "description": "Lifetime of IKE SA of customer gateway",
+ "name": "ikelifetime",
+ "type": "long"
+ },
+ {
+ "description": "the vpn gateway ID",
+ "name": "s2svpngatewayid",
"type": "string"
},
{
@@ -90754,18 +92179,23 @@
"type": "string"
},
{
- "description": "the vpn gateway ID",
- "name": "s2svpngatewayid",
+ "description": "if DPD is enabled for customer gateway",
+ "name": "dpd",
+ "type": "boolean"
+ },
+ {
+ "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.",
+ "name": "splitconnections",
+ "type": "boolean"
+ },
+ {
+ "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike",
+ "name": "ikeversion",
"type": "string"
},
{
- "description": "the owner",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the connection ID",
- "name": "id",
+ "description": "public ip address id of the customer gateway",
+ "name": "gateway",
"type": "string"
},
{
@@ -90774,40 +92204,46 @@
"type": "boolean"
},
{
- "description": "the date and time the host was created",
- "name": "created",
- "type": "date"
+ "description": "the connection ID",
+ "name": "id",
+ "type": "string"
},
{
- "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.",
- "name": "splitconnections",
+ "description": "the owner",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the domain name of the owner",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "State of vpn connection",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "the domain id of the owner",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the project id",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "State of vpn connection",
+ "name": "passive",
"type": "boolean"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "ESP policy of the customer gateway",
+ "name": "esppolicy",
"type": "string"
},
- {
- "description": "Lifetime of IKE SA of customer gateway",
- "name": "ikelifetime",
- "type": "long"
- },
- {
- "description": "if DPD is enabled for customer gateway",
- "name": "dpd",
- "type": "boolean"
- },
- {
- "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).",
- "name": "cidrlist",
- "type": "string"
- },
- {
- "description": "IKE policy of the customer gateway",
- "name": "ikepolicy",
- "type": "string"
- },
+ {},
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
@@ -90821,6 +92257,13 @@
"name": "listBrocadeVcsDeviceNetworks",
"params": [
{
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "brocade vcs switch ID",
"length": 255,
"name": "vcsdeviceid",
@@ -90836,13 +92279,6 @@
"type": "integer"
},
{
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
- },
- {
"description": "",
"length": 255,
"name": "pagesize",
@@ -90853,246 +92289,13 @@
"related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks",
"response": [
{
- "description": "the network's netmask",
- "name": "netmask",
+ "description": "name of the network offering the network is created from",
+ "name": "networkofferingname",
"type": "string"
},
{
- "description": "the name of the zone the network belongs to",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "the gateway of IPv6 network",
- "name": "ip6gateway",
- "type": "string"
- },
- {
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {},
- {
- "description": "the network's gateway",
- "name": "gateway",
- "type": "string"
- },
- {
- "description": "the network domain",
- "name": "networkdomain",
- "type": "string"
- },
- {
- "description": "network offering id the network is created from",
- "name": "networkofferingid",
- "type": "string"
- },
- {
- "description": "true if network can span multiple zones",
- "name": "strechedl2subnet",
- "type": "boolean"
- },
- {
- "description": "the traffic type of the network",
- "name": "traffictype",
- "type": "string"
- },
- {
- "description": "the date this network was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "acl type - access type to the network",
- "name": "acltype",
- "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",
- "type": "string"
- },
- {
- "description": "true if network 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": "list networks available for vm deployment",
- "name": "canusefordeploy",
- "type": "boolean"
- },
- {
- "description": "the domain name of the network owner",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans",
- "name": "zonesnetworkspans",
- "type": "set"
- },
- {
- "description": "true network requires restart",
- "name": "restartrequired",
- "type": "boolean"
- },
- {
- "description": "zone id of the network",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the list of services",
- "name": "service",
- "response": [
- {
- "description": "the service name",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the service provider name",
- "name": "provider",
- "response": [
- {
- "description": "the provider name",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the destination physical network",
- "name": "destinationphysicalnetworkid",
- "type": "string"
- },
- {
- "description": "uuid of the network provider",
- "name": "id",
- "type": "string"
- },
- {
- "description": "services for this provider",
- "name": "servicelist",
- "type": "list"
- },
- {
- "description": "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"
- }
- ],
- "type": "list"
- },
- {
- "description": "the list of capabilities",
- "name": "capability",
- "response": [
- {
- "description": "can this service capability value can be choosable while creatine network offerings",
- "name": "canchooseservicecapability",
- "type": "boolean"
- },
- {
- "description": "the capability name",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the capability value",
- "name": "value",
- "type": "string"
- }
- ],
- "type": "list"
- }
- ],
- "type": "list"
- },
- {
- "description": "true if network is system, false otherwise",
- "name": "issystem",
- "type": "boolean"
- },
- {
- "description": "The external id of the network",
- "name": "externalid",
- "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 first DNS for the network",
- "name": "dns1",
- "type": "string"
- },
- {},
- {
- "description": "the physical network id",
- "name": "physicalnetworkid",
- "type": "string"
- },
- {
- "description": "state of the network",
- "name": "state",
- "type": "string"
- },
- {
- "description": "the project name of the address",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the details of the network",
- "name": "details",
- "type": "map"
- },
- {
- "description": "related to what other network configuration",
- "name": "related",
- "type": "string"
- },
- {
- "description": "ACL name associated with the VPC network",
- "name": "aclname",
- "type": "string"
- },
- {
- "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes",
- "name": "reservediprange",
- "type": "string"
- },
- {
- "description": "If the network has redundant routers enabled",
- "name": "redundantrouter",
+ "description": "true if network offering is ip conserve mode enabled",
+ "name": "networkofferingconservemode",
"type": "boolean"
},
{
@@ -91100,36 +92303,11 @@
"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 value",
"name": "value",
"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"
@@ -91140,6 +92318,16 @@
"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"
@@ -91148,88 +92336,39 @@
"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 ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
}
],
"type": "list"
},
{
- "description": "Name of the VPC to which this network belongs",
- "name": "vpcname",
+ "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 netmask",
+ "name": "netmask",
"type": "string"
},
{
- "description": "true if users from subdomains can access the domain level network",
- "name": "subdomainaccess",
- "type": "boolean"
- },
- {
- "description": "the id of the network",
- "name": "id",
- "type": "string"
- },
- {
- "description": "Broadcast domain type of the network",
- "name": "broadcastdomaintype",
- "type": "string"
- },
- {
- "description": "the type of the network",
- "name": "type",
- "type": "string"
- },
- {
- "description": "ACL Id associated with the VPC network",
- "name": "aclid",
- "type": "string"
- },
- {
- "description": "the cidr of IPv6 network",
- "name": "ip6cidr",
- "type": "string"
- },
- {
- "description": "the total number of network traffic bytes sent",
- "name": "sentbytes",
- "type": "long"
- },
- {
- "description": "the owner of the network",
- "name": "account",
- "type": "string"
- },
- {
- "description": "list networks that are persistent",
- "name": "ispersistent",
- "type": "boolean"
- },
- {
- "description": "broadcast uri of the network. This parameter is visible to ROOT admins only",
- "name": "broadcasturi",
- "type": "string"
- },
- {
- "description": "an optional field, whether to the display the network to the end user or not.",
- "name": "displaynetwork",
- "type": "boolean"
- },
- {
- "description": "the total number of network traffic bytes received",
- "name": "receivedbytes",
- "type": "long"
- },
- {
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
- },
- {
- "description": "display text of the network offering the network is created from",
- "name": "networkofferingdisplaytext",
- "type": "string"
- },
- {
- "description": "the displaytext of the network",
- "name": "displaytext",
+ "description": "the gateway of IPv6 network",
+ "name": "ip6gateway",
"type": "string"
},
{
@@ -91238,9 +92377,14 @@
"type": "boolean"
},
{
- "description": "true if network offering is ip conserve mode enabled",
- "name": "networkofferingconservemode",
- "type": "boolean"
+ "description": "state of the network",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "the network's gateway",
+ "name": "gateway",
+ "type": "string"
},
{
"description": "The vlan of the network. This parameter is visible to ROOT admins only",
@@ -91248,13 +92392,134 @@
"type": "string"
},
{
+ "description": "zone id of the network",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "Name of the VPC to which this network belongs",
+ "name": "vpcname",
+ "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 network domain",
+ "name": "networkdomain",
+ "type": "string"
+ },
+ {
+ "description": "true if users from subdomains can access the domain level network",
+ "name": "subdomainaccess",
+ "type": "boolean"
+ },
+ {
+ "description": "an optional field, whether to the display the network to the end user or not.",
+ "name": "displaynetwork",
+ "type": "boolean"
+ },
+ {
+ "description": "availability of the network offering the network is created from",
+ "name": "networkofferingavailability",
+ "type": "string"
+ },
+ {
+ "description": "acl type - access type to the network",
+ "name": "acltype",
+ "type": "string"
+ },
+ {
"description": "VPC the network belongs to",
"name": "vpcid",
"type": "string"
},
{
- "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR",
- "name": "cidr",
+ "description": "the displaytext of the network",
+ "name": "displaytext",
+ "type": "string"
+ },
+ {
+ "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes",
+ "name": "reservediprange",
+ "type": "string"
+ },
+ {
+ "description": "true if network is system, false otherwise",
+ "name": "issystem",
+ "type": "boolean"
+ },
+ {
+ "description": "the project id of the ipaddress",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "ACL name associated with the VPC network",
+ "name": "aclname",
+ "type": "string"
+ },
+ {
+ "description": "the details of the network",
+ "name": "details",
+ "type": "map"
+ },
+ {
+ "description": "the total number of network traffic bytes received",
+ "name": "receivedbytes",
+ "type": "long"
+ },
+ {
+ "description": "the id of the network",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the first DNS for the network",
+ "name": "dns1",
+ "type": "string"
+ },
+ {
+ "description": "broadcast uri of the network. This parameter is visible to ROOT admins only",
+ "name": "broadcasturi",
+ "type": "string"
+ },
+ {
+ "description": "the date this network was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "The external id of the network",
+ "name": "externalid",
+ "type": "string"
+ },
+ {
+ "description": "related to what other network configuration",
+ "name": "related",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "display text of the network offering the network is created from",
+ "name": "networkofferingdisplaytext",
+ "type": "string"
+ },
+ {
+ "description": "the type of the network",
+ "name": "type",
+ "type": "string"
+ },
+ {
+ "description": "the name of the zone the network belongs to",
+ "name": "zonename",
"type": "string"
},
{
@@ -91263,8 +92528,134 @@
"type": "string"
},
{
- "description": "name of the network offering the network is created from",
- "name": "networkofferingname",
+ "description": "the second DNS for the network",
+ "name": "dns2",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the traffic type of the network",
+ "name": "traffictype",
+ "type": "string"
+ },
+ {
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE",
+ "name": "networkcidr",
+ "type": "string"
+ },
+ {
+ "description": "the physical network id",
+ "name": "physicalnetworkid",
+ "type": "string"
+ },
+ {
+ "description": "true if network can span multiple zones",
+ "name": "strechedl2subnet",
+ "type": "boolean"
+ },
+ {
+ "description": "the owner of the network",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the cidr of IPv6 network",
+ "name": "ip6cidr",
+ "type": "string"
+ },
+ {
+ "description": "true if network is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {
+ "description": "the list of 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",
+ "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": "state of the network provider",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "the provider name",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "uuid of the network provider",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "services for this provider",
+ "name": "servicelist",
+ "type": "list"
+ },
+ {
+ "description": "the destination physical network",
+ "name": "destinationphysicalnetworkid",
+ "type": "string"
+ }
+ ],
+ "type": "list"
+ }
+ ],
+ "type": "list"
+ },
+ {
+ "description": "the domain name of the network owner",
+ "name": "domain",
"type": "string"
},
{
@@ -91273,9 +92664,54 @@
"type": "string"
},
{
- "description": "the second DNS for the network",
- "name": "dns2",
+ "description": "Broadcast domain type of the network",
+ "name": "broadcastdomaintype",
"type": "string"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "true network requires restart",
+ "name": "restartrequired",
+ "type": "boolean"
+ },
+ {
+ "description": "the project name of the address",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "ACL Id associated with the VPC network",
+ "name": "aclid",
+ "type": "string"
+ },
+ {
+ "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR",
+ "name": "cidr",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "list networks available for vm deployment",
+ "name": "canusefordeploy",
+ "type": "boolean"
+ },
+ {
+ "description": "If the network has redundant routers enabled",
+ "name": "redundantrouter",
+ "type": "boolean"
+ },
+ {
+ "description": "the total number of network traffic bytes sent",
+ "name": "sentbytes",
+ "type": "long"
}
]
},
@@ -91294,6 +92730,17 @@
}
],
"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",
@@ -91304,18 +92751,7 @@
"description": "true if operation is executed successfully",
"name": "success",
"type": "boolean"
- },
- {
- "description": "any text associated with the success or failure",
- "name": "displaytext",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {}
+ }
],
"since": "3.0.0"
},
@@ -91325,6 +92761,14 @@
"name": "dedicateHost",
"params": [
{
+ "description": "the ID of the containing domain",
+ "length": 255,
+ "name": "domainid",
+ "related": "listDomainChildren,listDomains",
+ "required": true,
+ "type": "uuid"
+ },
+ {
"description": "the ID of the host to update",
"length": 255,
"name": "hostid",
@@ -91338,38 +92782,40 @@
"name": "account",
"required": false,
"type": "string"
- },
- {
- "description": "the ID of the containing domain",
- "length": 255,
- "name": "domainid",
- "related": "listDomainChildren,listDomains",
- "required": true,
- "type": "uuid"
}
],
"related": "listDedicatedHosts",
"response": [
{
- "description": "the domain ID of the host",
- "name": "domainid",
+ "description": "the ID of the host",
+ "name": "hostid",
"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 UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
{
- "description": "the Account ID of the host",
- "name": "accountid",
+ "description": "the ID of the dedicated resource",
+ "name": "id",
"type": "string"
},
- {},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "the domain ID of the host",
+ "name": "domainid",
+ "type": "string"
},
{
"description": "the Dedication Affinity Group ID of the host",
@@ -91381,17 +92827,7 @@
"name": "hostname",
"type": "string"
},
- {
- "description": "the ID of the host",
- "name": "hostid",
- "type": "string"
- },
- {},
- {
- "description": "the ID of the dedicated resource",
- "name": "id",
- "type": "string"
- }
+ {}
]
},
{
@@ -91400,6 +92836,20 @@
"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": "username for the vpn user",
+ "length": 255,
+ "name": "username",
+ "required": true,
+ "type": "string"
+ },
+ {
"description": "an optional domainId for the vpn user. If the account parameter is used, domainId must also be used.",
"length": 255,
"name": "domainid",
@@ -91414,30 +92864,10 @@
"related": "activateProject,suspendProject",
"required": false,
"type": "uuid"
- },
- {
- "description": "an optional account for the vpn user. Must be used with domainId.",
- "length": 255,
- "name": "account",
- "required": false,
- "type": "string"
- },
- {
- "description": "username for the vpn user",
- "length": 255,
- "name": "username",
- "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"
@@ -91452,6 +92882,12 @@
"description": "any text associated with the success or failure",
"name": "displaytext",
"type": "string"
+ },
+ {},
+ {
+ "description": "true if operation is executed successfully",
+ "name": "success",
+ "type": "boolean"
}
]
},
@@ -91461,9 +92897,9 @@
"name": "addGloboDnsHost",
"params": [
{
- "description": "Password for GloboDNS",
+ "description": "GloboDNS url",
"length": 255,
- "name": "password",
+ "name": "url",
"required": true,
"type": "string"
},
@@ -91476,9 +92912,9 @@
"type": "uuid"
},
{
- "description": "GloboDNS url",
+ "description": "Password for GloboDNS",
"length": 255,
- "name": "url",
+ "name": "password",
"required": true,
"type": "string"
},
@@ -91491,12 +92927,12 @@
}
],
"response": [
- {},
{
- "description": "any text associated with the success or failure",
- "name": "displaytext",
- "type": "string"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
+ {},
{
"description": "true if operation is executed successfully",
"name": "success",
@@ -91509,9 +92945,9 @@
},
{},
{
- "description": "the 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.5.0"
@@ -91524,22 +92960,22 @@
"related": "",
"response": [
{
- "description": "Response description",
- "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": "Response description",
+ "name": "description",
+ "type": "string"
+ }
]
},
{
@@ -91557,24 +92993,24 @@
}
],
"response": [
- {
- "description": "any text associated with the success or failure",
- "name": "displaytext",
- "type": "string"
- },
+ {},
{},
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
- {},
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
{
+ "description": "any text associated with the success or failure",
+ "name": "displaytext",
+ "type": "string"
+ },
+ {
"description": "true if operation is executed successfully",
"name": "success",
"type": "boolean"
@@ -91588,6 +93024,13 @@
"name": "importRole",
"params": [
{
+ "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User",
+ "length": 255,
+ "name": "type",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "Creates a role with this unique name",
"length": 255,
"name": "name",
@@ -91595,13 +93038,6 @@
"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.",
- "length": 255,
- "name": "forced",
- "required": false,
- "type": "boolean"
- },
- {
"description": "The description of the role",
"length": 255,
"name": "description",
@@ -91616,11 +93052,11 @@
"type": "map"
},
{
- "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User",
+ "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": "type",
+ "name": "forced",
"required": false,
- "type": "string"
+ "type": "boolean"
}
],
"related": "",
@@ -91630,9 +93066,10 @@
"name": "jobid",
"type": "string"
},
+ {},
{
- "description": "the description of the role",
- "name": "description",
+ "description": "the name of the role",
+ "name": "name",
"type": "string"
},
{
@@ -91641,6 +93078,17 @@
"type": "string"
},
{
+ "description": "true if role is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {
+ "description": "the description of the role",
+ "name": "description",
+ "type": "string"
+ },
+ {},
+ {
"description": "the ID of the role",
"name": "id",
"type": "string"
@@ -91649,19 +93097,7 @@
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
- },
- {
- "description": "true if role is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
- },
- {},
- {
- "description": "the name of the role",
- "name": "name",
- "type": "string"
- },
- {}
+ }
],
"since": "4.15.0"
},
@@ -91671,18 +93107,11 @@
"name": "listSwifts",
"params": [
{
- "description": "the id of the swift",
+ "description": "List by keyword",
"length": 255,
- "name": "id",
+ "name": "keyword",
"required": false,
- "type": "long"
- },
- {
- "description": "",
- "length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
+ "type": "string"
},
{
"description": "",
@@ -91692,75 +93121,30 @@
"type": "integer"
},
{
- "description": "List by keyword",
+ "description": "",
"length": 255,
- "name": "keyword",
+ "name": "page",
"required": false,
- "type": "string"
+ "type": "integer"
+ },
+ {
+ "description": "the id of the swift",
+ "length": 255,
+ "name": "id",
+ "required": false,
+ "type": "long"
}
],
"related": "addImageStoreS3,listImageStores",
"response": [
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the name of the image store",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the ID of the image store",
- "name": "id",
- "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 host's currently used disk size",
"name": "disksizeused",
"type": "long"
},
- {},
{
- "description": "defines if store is read-only",
- "name": "readonly",
- "type": "boolean"
- },
- {
- "description": "the protocol of the image store",
- "name": "protocol",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "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",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
@@ -91769,9 +93153,61 @@
"type": "string"
},
{
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
"description": "the url of the image store",
"name": "url",
"type": "string"
+ },
+ {
+ "description": "the protocol of the image store",
+ "name": "protocol",
+ "type": "string"
+ },
+ {
+ "description": "the provider name of the image store",
+ "name": "providername",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the total disk size of the host",
+ "name": "disksizetotal",
+ "type": "long"
+ },
+ {
+ "description": "defines if store is read-only",
+ "name": "readonly",
+ "type": "boolean"
+ },
+ {},
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the name of the image store",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the scope of the image store",
+ "name": "scope",
+ "type": "scopetype"
+ },
+ {
+ "description": "the Zone ID of the image store",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the image store",
+ "name": "id",
+ "type": "string"
}
],
"since": "3.0.0"
@@ -91793,20 +93229,8 @@
"related": "",
"response": [
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "operation status",
- "name": "status",
- "type": "boolean"
- },
- {},
- {},
- {
- "description": "the host HA provider",
- "name": "haprovider",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
@@ -91814,19 +93238,31 @@
"name": "haenable",
"type": "boolean"
},
+ {},
+ {},
+ {
+ "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 ID of the host",
+ "name": "hostid",
+ "type": "string"
+ },
{
"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 ID of the host",
- "name": "hostid",
+ "description": "the host HA provider",
+ "name": "haprovider",
"type": "string"
}
],
@@ -91849,34 +93285,13 @@
"related": "disableOutOfBandManagementForCluster",
"response": [
{
- "description": "the out-of-band management interface port",
- "name": "port",
- "type": "string"
- },
- {},
- {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
{
- "description": "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",
- "type": "string"
- },
- {
- "description": "the out-of-band management interface address",
- "name": "address",
+ "description": "the out-of-band management interface username",
+ "name": "username",
"type": "string"
},
{
@@ -91885,9 +93300,9 @@
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "the out-of-band management interface address",
+ "name": "address",
+ "type": "string"
},
{},
{
@@ -91895,24 +93310,45 @@
"name": "description",
"type": "string"
},
+ {},
+ {
+ "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 operation result",
"name": "status",
"type": "boolean"
},
{
- "description": "the out-of-band management interface username",
- "name": "username",
+ "description": "the ID of the host",
+ "name": "hostid",
"type": "string"
},
{
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the out-of-band management interface powerState of the host",
+ "name": "powerstate",
+ "type": "powerstate"
+ },
+ {
"description": "true if out-of-band management is enabled for the host",
"name": "enabled",
"type": "boolean"
},
{
- "description": "the out-of-band management driver for the host",
- "name": "driver",
+ "description": "the out-of-band management interface port",
+ "name": "port",
"type": "string"
}
],
@@ -91933,16 +93369,111 @@
}
],
"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": "Lists supported Kubernetes version",
+ "isasync": false,
+ "name": "listKubernetesSupportedVersions",
+ "params": [
+ {
+ "description": "the ID of the Kubernetes supported version",
+ "length": 255,
+ "name": "id",
+ "related": "listKubernetesSupportedVersions",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "the ID of the zone in which Kubernetes supported version will be available",
+ "length": 255,
+ "name": "zoneid",
+ "related": "createZone,listZones",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "the minimum semantic version for the Kubernetes supported version to be listed",
+ "length": 255,
+ "name": "minimumsemanticversion",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "the ID of the minimum Kubernetes supported version",
+ "length": 255,
+ "name": "minimumkubernetesversionid",
+ "related": "listKubernetesSupportedVersions",
+ "required": false,
+ "type": "uuid"
+ }
+ ],
+ "related": "",
+ "response": [
+ {},
+ {
+ "description": "the name of the zone in which Kubernetes supported version is available",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "whether Kubernetes supported version supports Autoscaling",
+ "name": "supportsautoscaling",
+ "type": "boolean"
+ },
+ {},
+ {
+ "description": "the minimum number of CPUs needed for the Kubernetes supported version",
+ "name": "mincpunumber",
+ "type": "integer"
+ },
+ {
+ "description": "the name of the binaries ISO for Kubernetes supported version",
+ "name": "isoname",
+ "type": "string"
},
{
"description": "the UUID of the latest async job acting on this object",
@@ -91950,11 +93481,55 @@
"type": "string"
},
{
+ "description": "the minimum RAM size in MB needed for the Kubernetes supported version",
+ "name": "minmemory",
+ "type": "integer"
+ },
+ {
+ "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 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",
+ "type": "string"
+ },
+ {
+ "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",
+ "type": "string"
+ },
+ {
+ "description": "Kubernetes semantic version",
+ "name": "semanticversion",
+ "type": "string"
+ },
+ {
+ "description": "the id of the Kubernetes supported version",
+ "name": "id",
+ "type": "string"
+ }
]
},
{
@@ -91963,6 +93538,20 @@
"name": "addNiciraNvpDevice",
"params": [
{
+ "description": "The L2 Gateway Service UUID configured on the Nicira Controller",
+ "length": 255,
+ "name": "l2gatewayserviceuuid",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "Credentials to access the Nicira Controller API",
+ "length": 255,
+ "name": "password",
+ "required": true,
+ "type": "string"
+ },
+ {
"description": "Credentials to access the Nicira Controller API",
"length": 255,
"name": "username",
@@ -91970,6 +93559,21 @@
"type": "string"
},
{
+ "description": "The L3 Gateway Service UUID configured on the Nicira Controller",
+ "length": 255,
+ "name": "l3gatewayserviceuuid",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the Physical Network ID",
+ "length": 255,
+ "name": "physicalnetworkid",
+ "related": "createPhysicalNetwork",
+ "required": true,
+ "type": "uuid"
+ },
+ {
"description": "The Transportzone UUID configured on the Nicira Controller",
"length": 255,
"name": "transportzoneuuid",
@@ -91982,79 +93586,24 @@
"name": "hostname",
"required": true,
"type": "string"
- },
- {
- "description": "The L2 Gateway Service UUID configured on the Nicira Controller",
- "length": 255,
- "name": "l2gatewayserviceuuid",
- "required": false,
- "type": "string"
- },
- {
- "description": "the Physical Network ID",
- "length": 255,
- "name": "physicalnetworkid",
- "related": "createPhysicalNetwork",
- "required": true,
- "type": "uuid"
- },
- {
- "description": "Credentials to access the Nicira Controller API",
- "length": 255,
- "name": "password",
- "required": true,
- "type": "string"
- },
- {
- "description": "The L3 Gateway Service UUID configured on the Nicira Controller",
- "length": 255,
- "name": "l3gatewayserviceuuid",
- "required": false,
- "type": "string"
}
],
"related": "",
"response": [
- {
- "description": "device id of the Nicire Nvp",
- "name": "nvpdeviceid",
- "type": "string"
- },
{},
{
- "description": "the transport zone Uuid",
- "name": "transportzoneuuid",
- "type": "string"
- },
- {},
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
"description": "device name",
"name": "niciradevicename",
"type": "string"
},
{
- "description": "the controller Ip address",
- "name": "hostname",
+ "description": "this L3 gateway service Uuid",
+ "name": "l3gatewayserviceuuid",
"type": "string"
},
{
- "description": "the physical network to which this Nirica Nvp belongs to",
- "name": "physicalnetworkid",
- "type": "string"
- },
- {
- "description": "name of the provider",
- "name": "provider",
+ "description": "the transport zone Uuid",
+ "name": "transportzoneuuid",
"type": "string"
},
{
@@ -92063,8 +93612,34 @@
"type": "string"
},
{
- "description": "this L3 gateway service Uuid",
- "name": "l3gatewayserviceuuid",
+ "description": "name of the provider",
+ "name": "provider",
+ "type": "string"
+ },
+ {
+ "description": "the controller Ip address",
+ "name": "hostname",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the physical network to which this Nirica Nvp belongs to",
+ "name": "physicalnetworkid",
+ "type": "string"
+ },
+ {
+ "description": "device id of the Nicire Nvp",
+ "name": "nvpdeviceid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
}
]
@@ -92075,16 +93650,16 @@
"name": "addF5LoadBalancer",
"params": [
{
- "description": "Credentials to reach F5 BigIP load balancer device",
+ "description": "URL of the F5 load balancer appliance.",
"length": 255,
- "name": "password",
+ "name": "url",
"required": true,
"type": "string"
},
{
"description": "Credentials to reach F5 BigIP load balancer device",
"length": 255,
- "name": "username",
+ "name": "password",
"required": true,
"type": "string"
},
@@ -92096,24 +93671,40 @@
"type": "string"
},
{
- "description": "URL of the F5 load balancer appliance.",
- "length": 255,
- "name": "url",
- "required": true,
- "type": "string"
- },
- {
"description": "the Physical Network ID",
"length": 255,
"name": "physicalnetworkid",
"related": "createPhysicalNetwork",
"required": true,
"type": "uuid"
+ },
+ {
+ "description": "Credentials to reach F5 BigIP load balancer device",
+ "length": 255,
+ "name": "username",
+ "required": true,
+ "type": "string"
}
],
"related": "",
"response": [
{
+ "description": "device capacity",
+ "name": "lbdevicecapacity",
+ "type": "long"
+ },
+ {
+ "description": "the physical network to which this F5 device belongs to",
+ "name": "physicalnetworkid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the private interface of the load balancer",
+ "name": "privateinterface",
+ "type": "string"
+ },
+ {
"description": "the public interface of the load balancer",
"name": "publicinterface",
"type": "string"
@@ -92124,45 +93715,29 @@
"type": "boolean"
},
{
- "description": "device capacity",
- "name": "lbdevicecapacity",
- "type": "long"
- },
- {
- "description": "name of the provider",
- "name": "provider",
+ "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 F5 load balancer",
- "name": "lbdeviceid",
- "type": "string"
- },
- {
- "description": "the physical network to which this F5 device belongs to",
- "name": "physicalnetworkid",
- "type": "string"
- },
- {
"description": "device state",
"name": "lbdevicestate",
"type": "string"
},
{
- "description": "the private interface of the load balancer",
- "name": "privateinterface",
+ "description": "name of the provider",
+ "name": "provider",
"type": "string"
},
{
- "description": "device name",
- "name": "lbdevicename",
+ "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"
},
{
@@ -92171,8 +93746,8 @@
"type": "string"
},
{
- "description": "the management IP address of the external load balancer",
- "name": "ipaddress",
+ "description": "device id of the F5 load balancer",
+ "name": "lbdeviceid",
"type": "string"
}
]
@@ -92185,17 +93760,16 @@
{
"description": "",
"length": 255,
- "name": "page",
+ "name": "pagesize",
"required": false,
"type": "integer"
},
{
- "description": "the Physical Network ID",
+ "description": "",
"length": 255,
- "name": "physicalnetworkid",
- "related": "createPhysicalNetwork",
+ "name": "page",
"required": false,
- "type": "uuid"
+ "type": "integer"
},
{
"description": "list providers by name",
@@ -92212,11 +93786,12 @@
"type": "string"
},
{
- "description": "",
+ "description": "the Physical Network ID",
"length": 255,
- "name": "pagesize",
+ "name": "physicalnetworkid",
+ "related": "createPhysicalNetwork",
"required": false,
- "type": "integer"
+ "type": "uuid"
},
{
"description": "List by keyword",
@@ -92229,31 +93804,15 @@
"related": "",
"response": [
{
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
"description": "the physical network this belongs to",
"name": "physicalnetworkid",
"type": "string"
},
- {
- "description": "true if individual services can be enabled/disabled",
- "name": "canenableindividualservice",
- "type": "boolean"
- },
- {},
- {
- "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 destination physical network",
@@ -92261,19 +93820,35 @@
"type": "string"
},
{
- "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"
},
{
"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": "true if individual services can be enabled/disabled",
+ "name": "canenableindividualservice",
+ "type": "boolean"
+ },
+ {
+ "description": "uuid of the network provider",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the provider name",
+ "name": "name",
+ "type": "string"
}
],
"since": "3.0.0"
@@ -92286,18 +93861,19 @@
"related": "",
"response": [
{
- "description": "Number of cpu sockets",
- "name": "cpusockets",
- "type": "integer"
- },
- {
"description": "Number of Alerts",
"name": "alerts",
"type": "integer"
},
+ {},
{
- "description": "Number of clusters",
- "name": "clusters",
+ "description": "Number of routers",
+ "name": "routers",
+ "type": "integer"
+ },
+ {
+ "description": "Number of hypervisor hosts",
+ "name": "hosts",
"type": "integer"
},
{
@@ -92306,18 +93882,8 @@
"type": "string"
},
{
- "description": "Number of internal LBs",
- "name": "ilbvms",
- "type": "integer"
- },
- {
- "description": "Number of routers",
- "name": "routers",
- "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"
},
{
@@ -92325,15 +93891,29 @@
"name": "zones",
"type": "integer"
},
- {},
+ {
+ "description": "Number of pods",
+ "name": "pods",
+ "type": "integer"
+ },
+ {
+ "description": "Number of management servers",
+ "name": "managementservers",
+ "type": "integer"
+ },
{
"description": "Number of images stores",
"name": "imagestores",
"type": "integer"
},
{
- "description": "Number of pods",
- "name": "pods",
+ "description": "Number of systemvms",
+ "name": "systemvms",
+ "type": "integer"
+ },
+ {
+ "description": "Number of internal LBs",
+ "name": "ilbvms",
"type": "integer"
},
{},
@@ -92343,18 +93923,13 @@
"type": "integer"
},
{
- "description": "Number of hypervisor hosts",
- "name": "hosts",
+ "description": "Number of cpu sockets",
+ "name": "cpusockets",
"type": "integer"
},
{
- "description": "Number of management servers",
- "name": "managementservers",
- "type": "integer"
- },
- {
- "description": "Number of systemvms",
- "name": "systemvms",
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
"type": "integer"
}
],
@@ -92366,55 +93941,19 @@
"name": "listUsageRecords",
"params": [
{
- "description": "List usage records for specified project",
+ "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": "projectid",
- "related": "activateProject,suspendProject",
+ "name": "isrecursive",
"required": false,
- "type": "uuid"
- },
- {
- "description": "Flag to enable display of Tags for a resource",
- "length": 255,
- "name": "includetags",
- "required": false,
+ "since": "4.15",
"type": "boolean"
},
{
- "description": "List by keyword",
+ "description": "",
"length": 255,
- "name": "keyword",
+ "name": "pagesize",
"required": false,
- "type": "string"
- },
- {
- "description": "List usage records for the specified usage UUID. Can be used only together with TYPE parameter.",
- "length": 255,
- "name": "usageid",
- "required": false,
- "type": "string"
- },
- {
- "description": "Start date range for usage record query (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\", e.g. startDate=2015-01-01 or startdate=2015-01-01 11:00:00).",
- "length": 255,
- "name": "startdate",
- "required": true,
- "type": "date"
- },
- {
- "description": "List usage records for the specified account",
- "length": 255,
- "name": "accountid",
- "related": "enableAccount,listAccounts,listAccounts",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "List usage records for the specified user.",
- "length": 255,
- "name": "account",
- "required": false,
- "type": "string"
+ "type": "integer"
},
{
"description": "List usage records for the specified domain.",
@@ -92425,11 +93964,11 @@
"type": "uuid"
},
{
- "description": "Flag to enable description rendered in old format which uses internal database IDs instead of UUIDs. False by default.",
+ "description": "Start date range for usage record query (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\", e.g. startDate=2015-01-01 or startdate=2015-01-01 11:00:00).",
"length": 255,
- "name": "oldformat",
- "required": false,
- "type": "boolean"
+ "name": "startdate",
+ "required": true,
+ "type": "date"
},
{
"description": "End date range for usage record query (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\", e.g. startDate=2015-01-01 or startdate=2015-01-01 10:30:00).",
@@ -92439,21 +93978,42 @@
"type": "date"
},
{
- "description": "",
+ "description": "List usage records for the specified user.",
"length": 255,
- "name": "pagesize",
+ "name": "account",
"required": false,
- "type": "integer"
+ "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.",
+ "description": "List by keyword",
"length": 255,
- "name": "isrecursive",
+ "name": "keyword",
"required": false,
- "since": "4.15",
+ "type": "string"
+ },
+ {
+ "description": "Flag to enable description rendered in old format which uses internal database IDs instead of UUIDs. False by default.",
+ "length": 255,
+ "name": "oldformat",
+ "required": false,
"type": "boolean"
},
{
+ "description": "Flag to enable display of Tags for a resource",
+ "length": 255,
+ "name": "includetags",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "List usage records for the specified account",
+ "length": 255,
+ "name": "accountid",
+ "related": "enableAccount,listAccounts,listAccounts",
+ "required": false,
+ "type": "uuid"
+ },
+ {
"description": "List usage records for the specified usage type",
"length": 255,
"name": "type",
@@ -92461,65 +94021,43 @@
"type": "long"
},
{
+ "description": "List usage records for specified project",
+ "length": 255,
+ "name": "projectid",
+ "related": "activateProject,suspendProject",
+ "required": false,
+ "type": "uuid"
+ },
+ {
"description": "",
"length": 255,
"name": "page",
"required": false,
"type": "integer"
+ },
+ {
+ "description": "List usage records for the specified usage UUID. Can be used only together with TYPE parameter.",
+ "length": 255,
+ "name": "usageid",
+ "required": false,
+ "type": "string"
}
],
"related": "",
"response": [
{
- "description": "resource or virtual machine name",
- "name": "name",
+ "description": "id of the resource",
+ "name": "usageid",
"type": "string"
},
{
- "description": "virtual machine guest os category ID",
- "name": "oscategoryid",
+ "description": "start date of the usage record",
+ "name": "startdate",
"type": "string"
},
{
- "description": "the project name of the resource",
- "name": "project",
- "type": "string"
- },
- {
- "description": "offering ID",
- "name": "offeringid",
- "type": "string"
- },
- {
- "description": "the user account Id",
- "name": "accountid",
- "type": "string"
- },
- {},
- {
- "description": "the zone ID",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the user account name",
- "name": "account",
- "type": "string"
- },
- {
- "description": "virtual machine ID",
- "name": "virtualmachineid",
- "type": "string"
- },
- {},
- {
- "description": "usage type ID",
- "name": "usagetype",
- "type": "integer"
- },
- {
- "description": "virtual machine os category name",
- "name": "oscategoryname",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
@@ -92528,8 +94066,48 @@
"type": "long"
},
{
- "description": "id of the resource",
- "name": "usageid",
+ "description": "virtual machine os display name",
+ "name": "osdisplayname",
+ "type": "string"
+ },
+ {
+ "description": "offering ID",
+ "name": "offeringid",
+ "type": "string"
+ },
+ {
+ "description": "virtual machine ID",
+ "name": "virtualmachineid",
+ "type": "string"
+ },
+ {
+ "description": "the user account name",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the domain the resource is associated with",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "id of the network",
+ "name": "networkid",
+ "type": "string"
+ },
+ {
+ "description": "template ID",
+ "name": "templateid",
+ "type": "string"
+ },
+ {
+ "description": "id of the vpc",
+ "name": "vpcid",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID",
+ "name": "domainid",
"type": "string"
},
{
@@ -92537,28 +94115,23 @@
"name": "tags",
"response": [
{
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
"description": "the ID of the domain associated with the tag",
"name": "domainid",
"type": "string"
},
{
- "description": "the domain associated with the tag",
- "name": "domain",
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
"type": "string"
},
{
@@ -92572,26 +94145,72 @@
"type": "string"
},
{
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
+ "description": "the account associated with the tag",
+ "name": "account",
"type": "string"
},
{
"description": "the project name where tag belongs to",
"name": "project",
"type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
}
],
"type": "set"
},
{
- "description": "resource type",
- "name": "type",
+ "description": "end date of the usage record",
+ "name": "enddate",
+ "type": "string"
+ },
+ {
+ "description": "the project id of the resource",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "usage type ID",
+ "name": "usagetype",
+ "type": "integer"
+ },
+ {
+ "description": "raw usage in hours",
+ "name": "rawusage",
+ "type": "string"
+ },
+ {
+ "description": "True if the resource is default",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {},
+ {
+ "description": "the project name of the resource",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "True if the IPAddress is system IP - allocated during vm deploy or lb rule create",
+ "name": "issystem",
+ "type": "boolean"
+ },
+ {
+ "description": "number of cpu of resource",
+ "name": "cpunumber",
+ "type": "long"
+ },
+ {
+ "description": "description of the usage record",
+ "name": "description",
"type": "string"
},
{
@@ -92600,19 +94219,20 @@
"type": "integer"
},
{
- "description": "the domain ID",
- "name": "domainid",
+ "description": "resource type",
+ "name": "type",
"type": "string"
},
{
- "description": "memory allocated for the resource",
- "name": "memory",
+ "description": "speed of each cpu of resource",
+ "name": "cpuspeed",
"type": "long"
},
+ {},
{
- "description": "id of the network",
- "name": "networkid",
- "type": "string"
+ "description": "resource size",
+ "name": "size",
+ "type": "long"
},
{
"description": "True if the IPAddress is source NAT",
@@ -92625,23 +94245,23 @@
"type": "string"
},
{
- "description": "speed of each cpu of resource",
- "name": "cpuspeed",
+ "description": "memory allocated for the resource",
+ "name": "memory",
"type": "long"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
"description": "true if the entity/resource has annotations",
"name": "hasannotations",
"type": "boolean"
},
{
- "description": "description of the usage record",
- "name": "description",
+ "description": "the user account Id",
+ "name": "accountid",
+ "type": "string"
+ },
+ {
+ "description": "resource or virtual machine name",
+ "name": "name",
"type": "string"
},
{
@@ -92650,63 +94270,18 @@
"type": "string"
},
{
- "description": "True if the IPAddress is system IP - allocated during vm deploy or lb rule create",
- "name": "issystem",
- "type": "boolean"
- },
- {
- "description": "start date of the usage record",
- "name": "startdate",
+ "description": "virtual machine os category name",
+ "name": "oscategoryname",
"type": "string"
},
{
- "description": "raw usage in hours",
- "name": "rawusage",
+ "description": "virtual machine guest os category ID",
+ "name": "oscategoryid",
"type": "string"
},
{
- "description": "template ID",
- "name": "templateid",
- "type": "string"
- },
- {
- "description": "the project id of the resource",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the domain the resource is associated with",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "resource size",
- "name": "size",
- "type": "long"
- },
- {
- "description": "number of cpu of resource",
- "name": "cpunumber",
- "type": "long"
- },
- {
- "description": "end date of the usage record",
- "name": "enddate",
- "type": "string"
- },
- {
- "description": "True if the resource is default",
- "name": "isdefault",
- "type": "boolean"
- },
- {
- "description": "id of the vpc",
- "name": "vpcid",
- "type": "string"
- },
- {
- "description": "virtual machine os display name",
- "name": "osdisplayname",
+ "description": "the zone ID",
+ "name": "zoneid",
"type": "string"
}
]
@@ -92728,26 +94303,26 @@
"response": [
{},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
},
+ {},
{
"description": "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"
- },
- {}
+ }
]
},
{
@@ -92770,6 +94345,7 @@
"name": "jobstatus",
"type": "integer"
},
+ {},
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
@@ -92785,8 +94361,7 @@
"description": "true if operation is executed successfully",
"name": "success",
"type": "boolean"
- },
- {}
+ }
]
},
{
@@ -92806,48 +94381,33 @@
"related": "createVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume",
"response": [
{
- "description": "state of the virtual machine",
- "name": "vmstate",
+ "description": "the name of the template for the virtual machine",
+ "name": "templatename",
"type": "string"
},
{
- "description": "pod id of the volume",
- "name": "podid",
+ "description": "ID of the availability zone",
+ "name": "zoneid",
"type": "string"
},
{
- "description": "ID of the service offering for root disk",
- "name": "serviceofferingid",
+ "description": "display name of the virtual machine",
+ "name": "vmdisplayname",
"type": "string"
},
{
- "description": "the bytes allocated",
- "name": "physicalsize",
- "type": "long"
- },
- {
- "description": "pod name of the volume",
- "name": "podname",
- "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",
+ "description": "an optional field whether to the display the volume to the end user or not.",
+ "name": "displayvolume",
"type": "boolean"
},
{
- "description": "the account associated with the disk volume",
- "name": "account",
+ "description": "id of the primary storage hosting the disk volume; returned to admin user only",
+ "name": "storageid",
"type": "string"
},
{
- "description": "name of the availability zone",
- "name": "zonename",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
@@ -92856,208 +94416,16 @@
"type": "string"
},
{
- "description": "type of the disk volume (ROOT or DATADISK)",
- "name": "type",
- "type": "string"
- },
- {
- "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.",
- "name": "deviceid",
- "type": "long"
- },
- {
- "description": "the chain info of the volume",
- "name": "chaininfo",
- "type": "string"
- },
- {
- "description": "the status of the volume",
- "name": "status",
- "type": "string"
- },
- {
"description": "io requests write rate of the disk volume per the disk offering",
"name": "diskIopsWriteRate",
"type": "long"
},
{
- "description": "ID of the disk offering",
- "name": "diskofferingid",
- "type": "string"
- },
- {
- "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.",
- "name": "templateid",
- "type": "string"
- },
- {
- "description": "the date the disk volume was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "name of the disk offering",
- "name": "diskofferingname",
- "type": "string"
- },
- {
- "description": "bytes read rate of the disk volume",
- "name": "diskBytesReadRate",
+ "description": "the read (bytes) of disk on the vm",
+ "name": "diskkbsread",
"type": "long"
},
{
- "description": "the name of the ISO attached to the virtual machine",
- "name": "isoname",
- "type": "string"
- },
- {
- "description": "true if storage snapshot is supported for the volume, false otherwise",
- "name": "supportsstoragesnapshot",
- "type": "boolean"
- },
- {
- "description": "the write (io) of disk on the vm",
- "name": "diskiowrite",
- "type": "long"
- },
- {
- "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": "cluster id of the volume",
- "name": "clusterid",
- "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 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": "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": "id of the resource",
- "name": "resourceid",
- "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": "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": "ID of the availability zone",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the display text of the service offering for root disk",
- "name": "serviceofferingdisplaytext",
- "type": "string"
- },
- {
- "description": "name of the virtual machine",
- "name": "vmname",
- "type": "string"
- },
- {
- "description": "name of the service offering for root disk",
- "name": "serviceofferingname",
- "type": "string"
- },
- {
- "description": "io requests read rate of the disk volume per the disk offering",
- "name": "diskIopsReadRate",
- "type": "long"
- },
- {
- "description": "the state of the disk volume",
- "name": "state",
- "type": "string"
- },
- {
- "description": "size of the disk volume",
- "name": "size",
- "type": "long"
- },
- {
- "description": "need quiesce vm or not when taking snapshot",
- "name": "quiescevm",
- "type": "boolean"
- },
- {
- "description": "ID of the disk volume",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the read (io) of disk on the vm",
- "name": "diskioread",
- "type": "long"
- },
- {
- "description": "id of the primary storage hosting the disk volume; returned to admin user only",
- "name": "storageid",
- "type": "string"
- },
- {
"description": "the display text of the disk offering",
"name": "diskofferingdisplaytext",
"type": "string"
@@ -93068,70 +94436,33 @@
"type": "long"
},
{
- "description": "name of the disk volume",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the bytes actually consumed on disk",
- "name": "virtualsize",
+ "description": "the write (bytes) of disk on the vm",
+ "name": "diskkbswrite",
"type": "long"
},
- {},
{
- "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": "the project name of the vpn",
- "name": "project",
- "type": "string"
+ "description": "need quiesce vm or not when taking snapshot",
+ "name": "quiescevm",
+ "type": "boolean"
},
{
- "description": "Hypervisor the volume belongs to",
- "name": "hypervisor",
+ "description": "ID of the disk volume",
+ "name": "id",
"type": "string"
},
{
- "description": "the ID of the domain associated with the disk volume",
- "name": "domainid",
- "type": "string"
- },
- {},
- {
"description": "the disk utilization",
"name": "utilization",
"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": "the project id of the vpn",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "cluster name where the volume is allocated",
- "name": "clustername",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "id of the virtual machine",
- "name": "virtualmachineid",
+ "description": "the ID of the ISO attached to the virtual machine",
+ "name": "isoid",
"type": "string"
},
{
@@ -93140,54 +94471,298 @@
"type": "long"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "type of the disk volume (ROOT or DATADISK)",
+ "name": "type",
"type": "string"
},
{
+ "description": "pod name of the volume",
+ "name": "podname",
+ "type": "string"
+ },
+ {
+ "description": "the bytes actually consumed on disk",
+ "name": "virtualsize",
+ "type": "long"
+ },
+ {
"description": "name of the primary storage hosting the disk volume",
"name": "storage",
"type": "string"
},
{
- "description": "an optional field whether to the display the volume to the end user or not.",
- "name": "displayvolume",
+ "description": "the path of the volume",
+ "name": "path",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the disk volume",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the disk volume",
+ "name": "domainid",
+ "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": "cluster id of the volume",
+ "name": "clusterid",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the disk volume",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the chain info of the volume",
+ "name": "chaininfo",
+ "type": "string"
+ },
+ {
+ "description": "the bytes allocated",
+ "name": "physicalsize",
+ "type": "long"
+ },
+ {
+ "description": "true if the volume is extractable, false otherwise",
+ "name": "isextractable",
"type": "boolean"
},
{
+ "description": "ID of the snapshot from which this volume was created",
+ "name": "snapshotid",
+ "type": "string"
+ },
+ {
+ "description": "the state of the disk volume",
+ "name": "state",
+ "type": "string"
+ },
+ {
"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": "ID of the service offering for root disk",
+ "name": "serviceofferingid",
+ "type": "string"
+ },
+ {
+ "description": "name of the availability zone",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "io requests read rate of the disk volume per the disk offering",
+ "name": "diskIopsReadRate",
+ "type": "long"
+ },
+ {
+ "description": "the display text of the service offering for root disk",
+ "name": "serviceofferingdisplaytext",
+ "type": "string"
+ },
+ {
+ "description": "name of the virtual machine",
+ "name": "vmname",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.",
+ "name": "deviceid",
+ "type": "long"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "bytes read rate of the disk volume",
+ "name": "diskBytesReadRate",
+ "type": "long"
+ },
+ {
+ "description": "the 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 project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "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 name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": " an alternate display text of the template for the virtual machine",
+ "name": "templatedisplaytext",
+ "type": "string"
+ },
+ {
+ "description": "size of the disk volume",
+ "name": "size",
+ "type": "long"
+ },
+ {
+ "description": "the status of the volume",
+ "name": "status",
+ "type": "string"
+ },
+ {
+ "description": "pod id of the volume",
+ "name": "podid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.",
+ "name": "templateid",
+ "type": "string"
+ },
+ {
+ "description": "cluster name where the volume is allocated",
+ "name": "clustername",
+ "type": "string"
+ },
+ {
+ "description": "id of the virtual machine",
+ "name": "virtualmachineid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the name of the ISO attached to the virtual machine",
+ "name": "isoname",
+ "type": "string"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "name of the service offering for root disk",
+ "name": "serviceofferingname",
+ "type": "string"
+ },
+ {
+ "description": "the write (io) of disk on the vm",
+ "name": "diskiowrite",
+ "type": "long"
+ },
+ {
+ "description": "min iops of the disk volume",
+ "name": "miniops",
+ "type": "long"
+ },
+ {
+ "description": "true if storage snapshot is supported for the volume, false otherwise",
+ "name": "supportsstoragesnapshot",
+ "type": "boolean"
+ },
+ {
+ "description": "the boolean state of whether the volume is destroyed or not",
+ "name": "destroyed",
+ "type": "boolean"
+ },
+ {
+ "description": "the read (io) of disk on the vm",
+ "name": "diskioread",
+ "type": "long"
+ },
+ {
+ "description": "state of the virtual machine",
+ "name": "vmstate",
+ "type": "string"
+ },
+ {
+ "description": "ID of the disk offering",
+ "name": "diskofferingid",
+ "type": "string"
+ },
+ {
+ "description": "Hypervisor the volume belongs to",
+ "name": "hypervisor",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the project id of the vpn",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "name of the disk offering",
+ "name": "diskofferingname",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the vpn",
+ "name": "project",
"type": "string"
},
{
"description": "provisioning type used to create volumes.",
"name": "provisioningtype",
"type": "string"
- },
- {
- "description": "display name of the virtual machine",
- "name": "vmdisplayname",
- "type": "string"
- },
- {
- "description": "the write (bytes) of disk on the vm",
- "name": "diskkbswrite",
- "type": "long"
- },
- {
- "description": "the read (bytes) of disk on the vm",
- "name": "diskkbsread",
- "type": "long"
- },
- {
- "description": "the domain associated with the disk volume",
- "name": "domain",
- "type": "string"
}
],
"since": "4.14.0"
@@ -93208,29 +94783,15 @@
],
"related": "createUser,getUser",
"response": [
+ {},
{
- "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": "true if user is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
- },
- {
- "description": "the secret key of the user",
- "name": "secretkey",
- "type": "string"
- },
- {
- "description": "the user email address",
- "name": "email",
- "type": "string"
- },
- {
- "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"
},
{
@@ -93239,8 +94800,44 @@
"type": "string"
},
{
- "description": "the account ID of the user",
- "name": "accountid",
+ "description": "the user name",
+ "name": "username",
+ "type": "string"
+ },
+ {
+ "description": "the account name of the user",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the user email address",
+ "name": "email",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the api key of the user",
+ "name": "apikey",
+ "type": "string"
+ },
+ {
+ "description": "the domain name of the user",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the type of the role",
+ "name": "roletype",
+ "type": "string"
+ },
+ {
+ "description": "the name of the role",
+ "name": "rolename",
+ "type": "string"
+ },
+ {
+ "description": "the user state",
+ "name": "state",
"type": "string"
},
{
@@ -93249,18 +94846,23 @@
"type": "short"
},
{
- "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",
+ "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 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 domain ID of the user",
+ "name": "domainid",
"type": "string"
},
{
@@ -93269,9 +94871,9 @@
"type": "string"
},
{
- "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",
+ "type": "boolean"
},
{
"description": "the timezone user was created in",
@@ -93284,51 +94886,24 @@
"type": "string"
},
{
+ "description": "the account ID of the user",
+ "name": "accountid",
+ "type": "string"
+ },
+ {
"description": "Base64 string representation of the resource icon",
"name": "icon",
"type": "resourceiconresponse"
},
{
- "description": "the user name",
- "name": "username",
- "type": "string"
- },
- {},
- {},
- {
- "description": "the name of the role",
- "name": "rolename",
+ "description": "the secret key of the user",
+ "name": "secretkey",
"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 type of the role",
- "name": "roletype",
- "type": "string"
- },
- {
- "description": "the api key of the user",
- "name": "apikey",
- "type": "string"
- },
- {
- "description": "the date and time the user account was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the user lastname",
- "name": "lastname",
- "type": "string"
- },
- {
- "description": "the boolean value representing if the updating target is in caller's child domain",
- "name": "iscallerchilddomain",
- "type": "boolean"
}
]
},
@@ -93338,6 +94913,49 @@
"name": "listZonesMetrics",
"params": [
{
+ "description": "the network type of the zone that the virtual machine belongs to",
+ "length": 255,
+ "name": "networktype",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "the name of the zone",
+ "length": 255,
+ "name": "name",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "the ID of the zone",
+ "length": 255,
+ "name": "id",
+ "related": "createZone,listZones",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "true if you want to retrieve all available Zones. False if you only want to return the Zones from which you have at least one VM. Default is false.",
+ "length": 255,
+ "name": "available",
+ "required": false,
+ "type": "boolean"
+ },
+ {
"description": "flag to display the resource image for the zones",
"length": 255,
"name": "showicon",
@@ -93345,6 +94963,20 @@
"type": "boolean"
},
{
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "flag to display the capacity of the zones",
+ "length": 255,
+ "name": "showcapacities",
+ "required": false,
+ "type": "boolean"
+ },
+ {
"description": "the ID of the domain associated with the zone",
"length": 255,
"name": "domainid",
@@ -93353,117 +94985,59 @@
"type": "uuid"
},
{
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
- },
- {
"description": "List zones by resource tags (key/value pairs)",
"length": 255,
"name": "tags",
"required": false,
"since": "4.3",
"type": "map"
- },
- {
- "description": "",
- "length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
- },
- {
- "description": "the name of the zone",
- "length": 255,
- "name": "name",
- "required": false,
- "type": "string"
- },
- {
- "description": "the ID of the zone",
- "length": 255,
- "name": "id",
- "related": "createZone,listZones",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "the network type of the zone that the virtual machine belongs to",
- "length": 255,
- "name": "networktype",
- "required": false,
- "type": "string"
- },
- {
- "description": "flag to display the capacity of the zones",
- "length": 255,
- "name": "showcapacities",
- "required": false,
- "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.",
- "length": 255,
- "name": "available",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "",
- "length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
}
],
"related": "",
"response": [
{
- "description": "the first IPv6 DNS for the Zone",
- "name": "ip6dns1",
+ "description": "the maximum memory deviation",
+ "name": "memorymaxdeviation",
"type": "string"
},
- {},
{
- "description": "cpu allocated disable threshold exceeded",
- "name": "cpuallocateddisablethreshold",
+ "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": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the total cpu capacity in GiB",
+ "name": "memorytotal",
+ "type": "string"
+ },
+ {
+ "description": "Meta data associated with the zone (key/value pairs)",
+ "name": "resourcedetails",
+ "type": "map"
+ },
+ {
+ "description": "true if security groups support is enabled, false otherwise",
+ "name": "securitygroupsenabled",
"type": "boolean"
},
{
- "description": "the allocation state of the cluster",
- "name": "allocationstate",
- "type": "string"
- },
- {
"description": "the total cpu allocated in GiB",
"name": "memoryallocated",
"type": "string"
},
{
- "description": "the dhcp Provider for the Zone",
- "name": "dhcpprovider",
- "type": "string"
- },
- {
- "description": "the second IPv6 DNS for the Zone",
- "name": "ip6dns2",
- "type": "string"
- },
- {
- "description": "the total cpu used in GiB",
- "name": "memoryused",
- "type": "string"
- },
- {
- "description": "the second DNS for the Zone",
- "name": "dns2",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the total cpu allocated in Ghz",
+ "name": "cpuallocated",
"type": "string"
},
{
@@ -93472,17 +95046,87 @@
"type": "boolean"
},
{
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "state of the cluster",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "the first internal DNS for the Zone",
+ "name": "internaldns1",
+ "type": "string"
+ },
+ {
+ "description": "the second internal DNS for the Zone",
+ "name": "internaldns2",
+ "type": "string"
+ },
+ {
+ "description": "the first DNS for the Zone",
+ "name": "dns1",
+ "type": "string"
+ },
+ {
+ "description": "Zone name",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the total cpu used in GiB",
+ "name": "memoryused",
+ "type": "string"
+ },
+ {
+ "description": "memory usage notification threshold exceeded",
+ "name": "memorythreshold",
+ "type": "boolean"
+ },
+ {
+ "description": "healthy / total clusters in the zone",
+ "name": "clusters",
+ "type": "string"
+ },
+ {
"description": "the list of resource tags associated with zone.",
"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": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
"description": "resource type",
"name": "resourcetype",
"type": "string"
},
{
- "description": "the project id the tag belongs to",
- "name": "projectid",
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
"type": "string"
},
{
@@ -93496,31 +95140,6 @@
"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": "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"
@@ -93529,61 +95148,76 @@
"type": "set"
},
{
- "description": "Zone description",
- "name": "description",
- "type": "string"
- },
- {
- "description": "the guest CIDR address for the Zone",
- "name": "guestcidraddress",
- "type": "string"
- },
- {
- "description": "true if security groups support is enabled, false otherwise",
- "name": "securitygroupsenabled",
- "type": "boolean"
- },
- {
- "description": "Zone Token",
- "name": "zonetoken",
- "type": "string"
- },
- {
- "description": "state of the cluster",
- "name": "state",
- "type": "string"
- },
- {
"description": "the UUID of the containing domain, null for public zones",
"name": "domainid",
"type": "string"
},
{
- "description": "the total cpu allocated in Ghz",
- "name": "cpuallocated",
+ "description": "the total cpu capacity in Ghz",
+ "name": "cputotal",
"type": "string"
},
{
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "description": "the dhcp Provider for the Zone",
+ "name": "dhcpprovider",
+ "type": "string"
+ },
+ {
+ "description": "memory allocated disable threshold exceeded",
+ "name": "memoryallocateddisablethreshold",
+ "type": "boolean"
+ },
+ {},
+ {
+ "description": "the first IPv6 DNS for the Zone",
+ "name": "ip6dns1",
+ "type": "string"
+ },
+ {
+ "description": "Network domain name for the networks in the zone",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "cpu usage disable threshold exceeded",
+ "name": "cpudisablethreshold",
+ "type": "boolean"
+ },
+ {
"description": "cpu usage notification threshold exceeded",
"name": "cputhreshold",
"type": "boolean"
},
{
- "description": "the maximum memory deviation",
- "name": "memorymaxdeviation",
- "type": "string"
- },
- {},
- {
"description": "the capacity of the Zone",
"name": "capacity",
"response": [
{
- "description": "the Zone name",
- "name": "zonename",
+ "description": "the capacity currently in use",
+ "name": "capacityused",
+ "type": "long"
+ },
+ {
+ "description": "the total capacity available",
+ "name": "capacitytotal",
+ "type": "long"
+ },
+ {
+ "description": "the percentage of capacity currently in use",
+ "name": "percentused",
"type": "string"
},
{
+ "description": "the capacity type",
+ "name": "type",
+ "type": "short"
+ },
+ {
"description": "the Cluster name",
"name": "clustername",
"type": "string"
@@ -93594,18 +95228,8 @@
"type": "long"
},
{
- "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 Zone ID",
+ "name": "zoneid",
"type": "string"
},
{
@@ -93614,106 +95238,47 @@
"type": "string"
},
{
+ "description": "the capacity name",
+ "name": "name",
+ "type": "string"
+ },
+ {
"description": "the Cluster ID",
"name": "clusterid",
"type": "string"
},
{
+ "description": "the Zone name",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
"description": "the Pod ID",
"name": "podid",
"type": "string"
- },
- {
- "description": "the total capacity available",
- "name": "capacitytotal",
- "type": "long"
- },
- {
- "description": "the Zone ID",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the percentage of capacity currently in use",
- "name": "percentused",
- "type": "string"
}
],
"type": "list"
},
{
- "description": "memory allocated notification threshold exceeded",
- "name": "memoryallocatedthreshold",
- "type": "boolean"
- },
- {
- "description": "the maximum cpu deviation",
- "name": "cpumaxdeviation",
+ "description": "Zone id",
+ "name": "id",
"type": "string"
},
- {
- "description": "healthy / total clusters in the zone",
- "name": "clusters",
- "type": "string"
- },
- {
- "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": "memory allocated disable threshold exceeded",
- "name": "memoryallocateddisablethreshold",
- "type": "boolean"
- },
- {
- "description": "memory usage notification threshold exceeded",
- "name": "memorythreshold",
- "type": "boolean"
- },
- {
- "description": "the total cpu capacity in GiB",
- "name": "memorytotal",
- "type": "string"
- },
- {
- "description": "the first DNS for the Zone",
- "name": "dns1",
- "type": "string"
- },
- {
- "description": "Meta data associated with the zone (key/value pairs)",
- "name": "resourcedetails",
- "type": "map"
- },
+ {},
{
"description": "cpu allocated notification threshold exceeded",
"name": "cpuallocatedthreshold",
"type": "boolean"
},
{
- "description": "the total cpu capacity in Ghz",
- "name": "cputotal",
- "type": "string"
- },
- {
"description": "true if local storage offering enabled, false otherwise",
"name": "localstorageenabled",
"type": "boolean"
},
{
- "description": "cpu usage disable threshold exceeded",
- "name": "cpudisablethreshold",
- "type": "boolean"
- },
- {
- "description": "the total cpu used in Ghz",
- "name": "cpuused",
+ "description": "the second IPv6 DNS for the Zone",
+ "name": "ip6dns2",
"type": "string"
},
{
@@ -93722,44 +95287,54 @@
"type": "string"
},
{
+ "description": "the allocation state of the cluster",
+ "name": "allocationstate",
+ "type": "string"
+ },
+ {
"description": "the name of the containing domain, null for public zones",
"name": "domainname",
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the first internal DNS for the Zone",
- "name": "internaldns1",
- "type": "string"
- },
- {
- "description": "the network type of the zone; can be Basic or Advanced",
- "name": "networktype",
- "type": "string"
- },
- {
- "description": "Zone name",
- "name": "name",
- "type": "string"
- },
- {
- "description": "Network domain name for the networks in the zone",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "Zone id",
- "name": "id",
- "type": "string"
+ "description": "memory allocated notification threshold exceeded",
+ "name": "memoryallocatedthreshold",
+ "type": "boolean"
},
{
"description": "true if the entity/resource has annotations",
"name": "hasannotations",
"type": "boolean"
+ },
+ {
+ "description": "Zone description",
+ "name": "description",
+ "type": "string"
+ },
+ {
+ "description": "the second DNS for the Zone",
+ "name": "dns2",
+ "type": "string"
+ },
+ {
+ "description": "the maximum cpu deviation",
+ "name": "cpumaxdeviation",
+ "type": "string"
+ },
+ {
+ "description": "the total cpu used in Ghz",
+ "name": "cpuused",
+ "type": "string"
+ },
+ {
+ "description": "cpu allocated disable threshold exceeded",
+ "name": "cpuallocateddisablethreshold",
+ "type": "boolean"
+ },
+ {
+ "description": "Zone Token",
+ "name": "zonetoken",
+ "type": "string"
}
],
"since": "4.9.3"
@@ -93770,6 +95345,14 @@
"name": "extractTemplate",
"params": [
{
+ "description": "the ID of the template",
+ "length": 255,
+ "name": "id",
+ "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos",
+ "required": true,
+ "type": "uuid"
+ },
+ {
"description": "the ID of the zone where the ISO is originally located",
"length": 255,
"name": "zoneid",
@@ -93778,13 +95361,6 @@
"type": "uuid"
},
{
- "description": "the url to which the ISO would be extracted",
- "length": 2048,
- "name": "url",
- "required": false,
- "type": "string"
- },
- {
"description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD",
"length": 255,
"name": "mode",
@@ -93792,22 +95368,83 @@
"type": "string"
},
{
- "description": "the ID of the template",
- "length": 255,
- "name": "id",
- "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos",
- "required": true,
- "type": "uuid"
+ "description": "the url to which the ISO would be extracted",
+ "length": 2048,
+ "name": "url",
+ "required": false,
+ "type": "string"
}
],
"related": "",
"response": [
{
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {},
+ {
+ "description": "zone name the object was extracted from",
+ "name": "zonename",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the time and date the object was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the name of the extracted object",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the upload id of extracted object",
+ "name": "extractId",
+ "type": "string"
+ },
+ {
+ "description": "the account id to which the extracted object belongs",
+ "name": "accountid",
+ "type": "string"
+ },
+ {
+ "description": "the id of extracted object",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the state of the extracted object",
+ "name": "state",
+ "type": "string"
+ },
+ {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
{
+ "description": "zone ID the object was extracted from",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the percentage of the entity uploaded to the specified location",
+ "name": "uploadpercentage",
+ "type": "integer"
+ },
+ {
+ "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded",
+ "name": "url",
+ "type": "string"
+ },
+ {
+ "description": "",
+ "name": "resultstring",
+ "type": "string"
+ },
+ {
"description": "type of the storage",
"name": "storagetype",
"type": "string"
@@ -93818,71 +95455,9 @@
"type": "string"
},
{
- "description": "zone ID the object was extracted from",
- "name": "zoneid",
- "type": "string"
- },
- {
"description": "the mode of extraction - upload or download",
"name": "extractMode",
"type": "string"
- },
- {
- "description": "the name of the extracted object",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the 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 percentage of the entity uploaded to the specified location",
- "name": "uploadpercentage",
- "type": "integer"
- },
- {
- "description": "the upload id of extracted object",
- "name": "extractId",
- "type": "string"
- },
- {},
- {
- "description": "the id of extracted object",
- "name": "id",
- "type": "string"
- },
- {},
- {
- "description": "zone name the object was extracted from",
- "name": "zonename",
- "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 state of the extracted object",
- "name": "state",
- "type": "string"
- },
- {
- "description": "",
- "name": "resultstring",
- "type": "string"
}
]
},
@@ -93901,12 +95476,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",
@@ -93917,11 +95497,6 @@
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
- },
- {
- "description": "true if operation is executed successfully",
- "name": "success",
- "type": "boolean"
}
]
},
@@ -93942,100 +95517,28 @@
"related": "activateProject",
"response": [
{
- "description": "the total primary storage space (in GiB) owned by project",
- "name": "primarystoragetotal",
- "type": "long"
+ "description": "the total number of snapshots available for this project",
+ "name": "snapshotavailable",
+ "type": "string"
},
{
- "description": "the list of resource tags associated with vm",
- "name": "tags",
- "response": [
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "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": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "the 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 total number of virtual machines that can be deployed by this project",
+ "name": "vmlimit",
+ "type": "string"
+ },
+ {
+ "description": "the account name of the project's owners",
+ "name": "owner",
"type": "list"
},
{
- "description": "the total number of virtual machines running for this project",
- "name": "vmrunning",
- "type": "integer"
- },
- {
- "description": "the total memory (in MB) owned by project",
- "name": "memorytotal",
- "type": "long"
- },
- {
- "description": "the total 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 number of cpu cores the project can own",
- "name": "cpulimit",
- "type": "string"
- },
- {
- "description": "the name of the project",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the total number of cpu cores available to be created for this project",
- "name": "cpuavailable",
+ "description": "the total volume available for this project",
+ "name": "volumeavailable",
"type": "string"
},
{
@@ -94044,43 +95547,38 @@
"type": "long"
},
{
- "description": "the total number of public ip addresses this project can acquire",
- "name": "iplimit",
+ "description": "the total memory (in MB) available to be created for this project",
+ "name": "memoryavailable",
"type": "string"
},
{
- "description": "the total number of virtual machines stopped for this project",
- "name": "vmstopped",
+ "description": "the current status of the latest async job acting 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 account name of the project's owners",
- "name": "owner",
- "type": "list"
- },
- {
- "description": "the total number of vpcs the project can own",
- "name": "vpclimit",
+ "description": "the total volume which can be used by this project",
+ "name": "volumelimit",
"type": "string"
},
{
- "description": "the total 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 id of the project",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the displaytext of the project",
- "name": "displaytext",
+ "description": "the state of the project",
+ "name": "state",
"type": "string"
},
{
@@ -94094,98 +95592,149 @@
"type": "string"
},
{
- "description": "the total number of cpu cores owned by project",
- "name": "cputotal",
+ "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 vpcs owned by project",
+ "name": "vpctotal",
"type": "long"
},
{
- "description": "the total number of public ip addresses available for this project to acquire",
- "name": "ipavailable",
- "type": "string"
- },
- {
- "description": "the total secondary storage space (in GiB) the project can own",
- "name": "secondarystoragelimit",
- "type": "string"
- },
- {
- "description": "the total volume available for this project",
- "name": "volumeavailable",
- "type": "string"
- },
- {
- "description": "the state of the project",
- "name": "state",
- "type": "string"
- },
- {
- "description": "the total number of snapshots available for this project",
- "name": "snapshotavailable",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
"description": "the total number of networks available to be created for this project",
"name": "networkavailable",
"type": "string"
},
{
- "description": "the total memory (in MB) the project can own",
- "name": "memorylimit",
+ "description": "the total number of cpu cores available to be created for this project",
+ "name": "cpuavailable",
"type": "string"
},
{
- "description": "the project account name of the project",
- "name": "projectaccountname",
- "type": "string"
- },
- {
- "description": "the total number of virtual machines that can be deployed by this project",
- "name": "vmlimit",
- "type": "string"
- },
- {
- "description": "the total volume which can be used by this project",
- "name": "volumelimit",
- "type": "string"
- },
- {
- "description": "the total number of templates which have been created by this project",
- "name": "templatetotal",
+ "description": "the total primary storage space (in GiB) owned by project",
+ "name": "primarystoragetotal",
"type": "long"
},
{
- "description": "the total number of templates available to be created by this project",
- "name": "templateavailable",
+ "description": "the name of the project",
+ "name": "name",
"type": "string"
},
{
- "description": "the domain id the project belongs to",
- "name": "domainid",
- "type": "string"
- },
- {},
- {
- "description": "the total number of snapshots which can be stored by this project",
- "name": "snapshotlimit",
+ "description": "the total number of public ip addresses this project can acquire",
+ "name": "iplimit",
"type": "string"
},
{
- "description": "the total number of networks owned by project",
- "name": "networktotal",
+ "description": "the total volume being used by this project",
+ "name": "volumetotal",
"type": "long"
},
{
- "description": "the date this project was created",
- "name": "created",
- "type": "date"
+ "description": "the list of resource tags associated with vm",
+ "name": "tags",
+ "response": [
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "tag 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": "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 project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ }
+ ],
+ "type": "list"
},
{},
{
+ "description": "the total number of cpu cores owned by project",
+ "name": "cputotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of cpu cores the project can own",
+ "name": "cpulimit",
+ "type": "string"
+ },
+ {
+ "description": "the total secondary storage space (in GiB) owned by project",
+ "name": "secondarystoragetotal",
+ "type": "float"
+ },
+ {
+ "description": "the total secondary storage space (in GiB) the project can own",
+ "name": "secondarystoragelimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of vpcs available to be created for this project",
+ "name": "vpcavailable",
+ "type": "string"
+ },
+ {
+ "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) 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 number of networks the project can own",
"name": "networklimit",
"type": "string"
@@ -94196,44 +95745,70 @@
"type": "string"
},
{
- "description": "the total memory (in MB) available to be created for this project",
- "name": "memoryavailable",
+ "description": "the id of the project",
+ "name": "id",
"type": "string"
},
{
- "description": "the total volume being used by this project",
- "name": "volumetotal",
- "type": "long"
- },
- {
"description": "the total number of snapshots stored by this project",
"name": "snapshottotal",
"type": "long"
},
+ {},
+ {
+ "description": "the date this project was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the total number of virtual machines stopped for this project",
+ "name": "vmstopped",
+ "type": "integer"
+ },
+ {
+ "description": "the total memory (in MB) the project can own",
+ "name": "memorylimit",
+ "type": "string"
+ },
{
"description": "Base64 string representation of the resource icon",
"name": "icon",
"type": "resourceiconresponse"
},
{
- "description": "the total number of vpcs available to be created for this project",
- "name": "vpcavailable",
- "type": "string"
- },
- {
- "description": "the total primary storage space (in GiB) the project can own",
- "name": "primarystoragelimit",
- "type": "string"
- },
- {
- "description": "the total number of vpcs owned by project",
- "name": "vpctotal",
+ "description": "the total number of networks owned by project",
+ "name": "networktotal",
"type": "long"
},
{
- "description": "the total secondary storage space (in GiB) owned by project",
- "name": "secondarystoragetotal",
- "type": "float"
+ "description": "the total number of templates available to be created by this project",
+ "name": "templateavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of templates which have been created by this project",
+ "name": "templatetotal",
+ "type": "long"
+ },
+ {
+ "description": "the total memory (in MB) owned by project",
+ "name": "memorytotal",
+ "type": "long"
+ },
+ {
+ "description": "the project account name of the project",
+ "name": "projectaccountname",
+ "type": "string"
+ },
+ {
+ "description": "the total number of snapshots which can be stored by this project",
+ "name": "snapshotlimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of virtual machines running for this project",
+ "name": "vmrunning",
+ "type": "integer"
}
],
"since": "3.0.0"
@@ -94244,14 +95819,6 @@
"name": "updateIpAddress",
"params": [
{
- "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, in case you want to set a custom id to the resource. Allowed to Root Admins only",
"length": 255,
"name": "customid",
@@ -94260,6 +95827,14 @@
"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,
"name": "fordisplay",
@@ -94271,9 +95846,14 @@
"related": "associateIpAddress,listPublicIpAddresses",
"response": [
{
- "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)",
- "name": "issystem",
- "type": "boolean"
+ "description": "virtual machine id the ip address is assigned to (not null only for static nat Ip)",
+ "name": "virtualmachineid",
+ "type": "string"
+ },
+ {
+ "description": "the project id of the ipaddress",
+ "name": "projectid",
+ "type": "string"
},
{
"description": "VPC name the ip belongs to",
@@ -94281,23 +95861,43 @@
"type": "string"
},
{
+ "description": "the virtual network for the IP address",
+ "name": "forvirtualnetwork",
+ "type": "boolean"
+ },
+ {
+ "description": "true if the IP address is a source nat address, false otherwise",
+ "name": "issourcenat",
+ "type": "boolean"
+ },
+ {
+ "description": "is public IP portable across the zones",
+ "name": "isportable",
+ "type": "boolean"
+ },
+ {
+ "description": "public IP address id",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "virtual machine name the ip address is assigned to (not null only for static nat Ip)",
+ "name": "virtualmachinename",
+ "type": "string"
+ },
+ {
"description": "virtual machine (dnat) ip address (not null only for static nat Ip)",
"name": "vmipaddress",
"type": "string"
},
{
- "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)",
- "name": "virtualmachinedisplayname",
+ "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": "the ID of the zone the public IP address belongs to",
- "name": "zoneid",
+ "description": "the project name of the address",
+ "name": "project",
"type": "string"
},
{
@@ -94312,8 +95912,13 @@
"type": "string"
},
{
- "description": "the name of the Network associated with the IP address",
- "name": "associatednetworkname",
+ "description": "the ID of the zone the public IP address belongs to",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "VPC id the ip belongs to",
+ "name": "vpcid",
"type": "string"
},
{
@@ -94322,11 +95927,6 @@
"type": "string"
},
{
- "description": "the ID of the Network associated with the IP address",
- "name": "associatednetworkid",
- "type": "string"
- },
- {
"description": "State of the ip address. Can be: Allocatin, Allocated and Releasing",
"name": "state",
"type": "string"
@@ -94336,6 +95936,87 @@
"name": "isstaticnat",
"type": "boolean"
},
+ {},
+ {
+ "description": "the ID of the Network associated with the IP address",
+ "name": "associatednetworkid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the Network where ip belongs to",
+ "name": "networkname",
+ "type": "string"
+ },
+ {
+ "description": "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",
+ "type": "string"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the name of the zone the public IP address belongs to",
+ "name": "zonename",
+ "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 ID of the Network where ip belongs to",
+ "name": "networkid",
+ "type": "string"
+ },
+ {
+ "description": "the domain the public IP address 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": "the physical network this belongs to",
+ "name": "physicalnetworkid",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID the public IP address is associated with",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "public IP address",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)",
+ "name": "issystem",
+ "type": "boolean"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
{
"description": "the list of resource tags associated with ip address",
"name": "tags",
@@ -94346,8 +96027,8 @@
"type": "string"
},
{
- "description": "id of the resource",
- "name": "resourceid",
+ "description": "the account associated with the tag",
+ "name": "account",
"type": "string"
},
{
@@ -94356,18 +96037,8 @@
"type": "string"
},
{
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
+ "description": "the project name where tag belongs to",
+ "name": "project",
"type": "string"
},
{
@@ -94376,8 +96047,13 @@
"type": "string"
},
{
- "description": "the project name where tag belongs to",
- "name": "project",
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
"type": "string"
},
{
@@ -94386,118 +96062,17 @@
"type": "string"
},
{
- "description": "tag key name",
- "name": "key",
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
"type": "string"
}
],
"type": "list"
- },
- {
- "description": "public IP address",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "description": "public IP address id",
- "name": "id",
- "type": "string"
- },
- {
- "description": "true if the IP address is a source nat address, false otherwise",
- "name": "issourcenat",
- "type": "boolean"
- },
- {
- "description": "the domain ID the public IP address is associated with",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the project id of the ipaddress",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the name of the zone the public IP address belongs to",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "the project name of the address",
- "name": "project",
- "type": "string"
- },
- {
- "description": "virtual machine id the ip address is assigned to (not null only for static nat Ip)",
- "name": "virtualmachineid",
- "type": "string"
- },
- {
- "description": "VPC id the ip belongs to",
- "name": "vpcid",
- "type": "string"
- },
- {
- "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only",
- "name": "vlanid",
- "type": "string"
- },
- {
- "description": "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": "date the public IP address was acquired",
- "name": "allocated",
- "type": "date"
- },
- {
- "description": "the account the public IP address is associated with",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {},
- {
- "description": "the name of the Network where ip belongs to",
- "name": "networkname",
- "type": "string"
- },
- {
- "description": "the virtual network for the IP address",
- "name": "forvirtualnetwork",
- "type": "boolean"
- },
- {
- "description": "virtual machine name the ip address is assigned to (not null only for static nat Ip)",
- "name": "virtualmachinename",
- "type": "string"
- },
- {
- "description": "the physical network this belongs to",
- "name": "physicalnetworkid",
- "type": "string"
- },
- {
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "the domain the public IP address is associated with",
- "name": "domain",
- "type": "string"
}
]
},
@@ -94509,6 +96084,27 @@
"related": "",
"response": [
{
+ "description": "the account uuid of the api remaining count",
+ "name": "accountid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "currently allowed number of apis",
+ "name": "apiAllowed",
+ "type": "int"
+ },
+ {
+ "description": "number of api already issued",
+ "name": "apiIssued",
+ "type": "int"
+ },
+ {
"description": "the account name of the api remaining count",
"name": "account",
"type": "string"
@@ -94523,28 +96119,7 @@
"name": "expireAfter",
"type": "long"
},
- {},
- {
- "description": "currently allowed number of apis",
- "name": "apiAllowed",
- "type": "int"
- },
- {},
- {
- "description": "number of api already issued",
- "name": "apiIssued",
- "type": "int"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the account uuid of the api remaining count",
- "name": "accountid",
- "type": "string"
- }
+ {}
]
},
{
@@ -94572,6 +96147,7 @@
"name": "jobid",
"type": "string"
},
+ {},
{
"description": "any text associated with the success or failure",
"name": "displaytext",
@@ -94582,7 +96158,6 @@
"name": "success",
"type": "boolean"
},
- {},
{}
],
"since": "3.0.0"
@@ -94601,31 +96176,41 @@
"type": "uuid"
},
{
- "description": "true if previous network migration cmd failed",
- "length": 255,
- "name": "resume",
- "required": false,
- "type": "boolean"
- },
- {
"description": "the ID of the network",
"length": 255,
"name": "networkid",
"related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks",
"required": true,
"type": "uuid"
+ },
+ {
+ "description": "true if previous network migration cmd failed",
+ "length": 255,
+ "name": "resume",
+ "required": false,
+ "type": "boolean"
}
],
"related": "createNetwork,updateNetwork,listNetworks,listF5LoadBalancerNetworks",
"response": [
{
- "description": "acl type - access type to the network",
- "name": "acltype",
+ "description": "the displaytext of the network",
+ "name": "displaytext",
"type": "string"
},
{
- "description": "Broadcast domain type of the network",
- "name": "broadcastdomaintype",
+ "description": "the network's gateway",
+ "name": "gateway",
+ "type": "string"
+ },
+ {
+ "description": "the network domain",
+ "name": "networkdomain",
+ "type": "string"
+ },
+ {
+ "description": "ACL name associated with the VPC network",
+ "name": "aclname",
"type": "string"
},
{
@@ -94634,36 +96219,115 @@
"type": "string"
},
{
+ "description": "the domain name of the network owner",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the traffic type of the network",
+ "name": "traffictype",
+ "type": "string"
+ },
+ {
+ "description": "The vlan of the network. This parameter is visible to ROOT admins only",
+ "name": "vlan",
+ "type": "string"
+ },
+ {
+ "description": "the name of the zone the network belongs to",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "the gateway of IPv6 network",
+ "name": "ip6gateway",
+ "type": "string"
+ },
+ {
+ "description": "list networks available for vm deployment",
+ "name": "canusefordeploy",
+ "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": "Broadcast domain type of the network",
+ "name": "broadcastdomaintype",
+ "type": "string"
+ },
+ {
+ "description": "name of the network offering the network is created from",
+ "name": "networkofferingname",
+ "type": "string"
+ },
+ {
+ "description": "state of the network",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "the project id of the ipaddress",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the details of the network",
+ "name": "details",
+ "type": "map"
+ },
+ {
+ "description": "display text of the network offering the network is created from",
+ "name": "networkofferingdisplaytext",
+ "type": "string"
+ },
+ {
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "description": "the id of the network",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "true network requires restart",
+ "name": "restartrequired",
+ "type": "boolean"
+ },
+ {
+ "description": "the domain id of the network owner",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "an optional field, whether to the display the network to the end user or not.",
+ "name": "displaynetwork",
+ "type": "boolean"
+ },
+ {
+ "description": "the type of the network",
+ "name": "type",
+ "type": "string"
+ },
+ {
+ "description": "the second DNS for the network",
+ "name": "dns2",
+ "type": "string"
+ },
+ {
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
{
- "description": "ACL name associated with the VPC network",
- "name": "aclname",
+ "description": "the network's netmask",
+ "name": "netmask",
"type": "string"
},
- {},
- {
- "description": "true if network is system, false otherwise",
- "name": "issystem",
- "type": "boolean"
- },
- {
- "description": "the total number of network traffic bytes received",
- "name": "receivedbytes",
- "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",
- "type": "boolean"
- },
{
"description": "the list of services",
"name": "service",
@@ -94678,26 +96342,6 @@
"name": "provider",
"response": [
{
- "description": "uuid of the network provider",
- "name": "id",
- "type": "string"
- },
- {
- "description": "true if individual services can be enabled/disabled",
- "name": "canenableindividualservice",
- "type": "boolean"
- },
- {
- "description": "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"
@@ -94708,6 +96352,26 @@
"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": "uuid of the network provider",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "services for this provider",
+ "name": "servicelist",
+ "type": "list"
+ },
+ {
"description": "state of the network provider",
"name": "state",
"type": "string"
@@ -94720,6 +96384,11 @@
"name": "capability",
"response": [
{
+ "description": "can this service capability value can be choosable while creatine network offerings",
+ "name": "canchooseservicecapability",
+ "type": "boolean"
+ },
+ {
"description": "the capability name",
"name": "name",
"type": "string"
@@ -94728,11 +96397,6 @@
"description": "the capability value",
"name": "value",
"type": "string"
- },
- {
- "description": "can this service capability value can be choosable while creatine network offerings",
- "name": "canchooseservicecapability",
- "type": "boolean"
}
],
"type": "list"
@@ -94741,63 +96405,100 @@
"type": "list"
},
{
- "description": "the date this network was created",
- "name": "created",
- "type": "date"
+ "description": "the total number of network traffic bytes sent",
+ "name": "sentbytes",
+ "type": "long"
},
{
- "description": "the domain name of the network owner",
- "name": "domain",
+ "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans",
+ "name": "zonesnetworkspans",
+ "type": "set"
+ },
+ {},
+ {
+ "description": "the cidr of IPv6 network",
+ "name": "ip6cidr",
"type": "string"
},
{
- "description": "zone id of the network",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "list networks available for vm deployment",
- "name": "canusefordeploy",
+ "description": "list networks that are persistent",
+ "name": "ispersistent",
"type": "boolean"
},
{
- "description": "network offering id the network is created from",
- "name": "networkofferingid",
- "type": "string"
- },
- {
- "description": "the name of the network",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the second DNS for the network",
- "name": "dns2",
- "type": "string"
- },
- {
- "description": "related to what other network configuration",
- "name": "related",
- "type": "string"
- },
- {
- "description": "the id of the network",
- "name": "id",
- "type": "string"
- },
- {
"description": "availability of the network offering the network is created from",
"name": "networkofferingavailability",
"type": "string"
},
{
+ "description": "ACL Id associated with the VPC network",
+ "name": "aclid",
+ "type": "string"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "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 external id of the network",
+ "name": "externalid",
+ "type": "string"
+ },
+ {
+ "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": "true if network is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {
+ "description": "VPC the network belongs to",
+ "name": "vpcid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "true if users from subdomains can access the domain level network",
+ "name": "subdomainaccess",
+ "type": "boolean"
+ },
+ {
+ "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR",
+ "name": "cidr",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the address",
+ "name": "project",
+ "type": "string"
+ },
+ {
"description": "the owner of the network",
"name": "account",
"type": "string"
},
{
- "description": "true network requires restart",
- "name": "restartrequired",
+ "description": "true if network can span multiple zones",
+ "name": "strechedl2subnet",
"type": "boolean"
},
{
@@ -94806,6 +96507,46 @@
"type": "boolean"
},
{
+ "description": "network offering id the network is created from",
+ "name": "networkofferingid",
+ "type": "string"
+ },
+ {
+ "description": "zone id of the network",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "acl type - access type to the network",
+ "name": "acltype",
+ "type": "string"
+ },
+ {
+ "description": "the physical network id",
+ "name": "physicalnetworkid",
+ "type": "string"
+ },
+ {
+ "description": "true if network is system, false otherwise",
+ "name": "issystem",
+ "type": "boolean"
+ },
+ {
+ "description": "the first DNS for the network",
+ "name": "dns1",
+ "type": "string"
+ },
+ {
+ "description": "related to what other network configuration",
+ "name": "related",
+ "type": "string"
+ },
+ {
+ "description": "the date this network was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
@@ -94816,125 +96557,10 @@
"type": "boolean"
},
{
- "description": "The vlan of the network. This parameter is visible to ROOT admins only",
- "name": "vlan",
- "type": "string"
- },
- {
- "description": "ACL Id associated with the VPC network",
- "name": "aclid",
- "type": "string"
- },
- {
- "description": "the gateway of IPv6 network",
- "name": "ip6gateway",
- "type": "string"
- },
- {
- "description": "broadcast uri of the network. This parameter is visible to ROOT admins only",
- "name": "broadcasturi",
- "type": "string"
- },
- {
- "description": "true if users from subdomains can access the domain level network",
- "name": "subdomainaccess",
- "type": "boolean"
- },
- {
- "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes",
- "name": "reservediprange",
- "type": "string"
- },
- {
- "description": "The external id of the network",
- "name": "externalid",
- "type": "string"
- },
- {
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
- },
- {
- "description": "name of the network offering the network is created from",
- "name": "networkofferingname",
- "type": "string"
- },
- {
- "description": "the physical network id",
- "name": "physicalnetworkid",
- "type": "string"
- },
- {
- "description": "Name of the VPC to which this network belongs",
- "name": "vpcname",
- "type": "string"
- },
- {
- "description": "the network domain",
- "name": "networkdomain",
- "type": "string"
- },
- {
- "description": "the domain id of the network owner",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the displaytext of the network",
- "name": "displaytext",
- "type": "string"
- },
- {
- "description": "the total number of network traffic bytes sent",
- "name": "sentbytes",
- "type": "long"
- },
- {
- "description": "the cidr of IPv6 network",
- "name": "ip6cidr",
- "type": "string"
- },
- {
- "description": "true if network is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
- },
- {
- "description": "the project name of the address",
- "name": "project",
- "type": "string"
- },
- {
"description": "the list of resource tags associated with network",
"name": "tags",
"response": [
{
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "the project 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": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
"description": "the domain associated with the tag",
"name": "domain",
"type": "string"
@@ -94950,11 +96576,36 @@
"type": "string"
},
{
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
"description": "the ID of the domain associated with the tag",
"name": "domainid",
"type": "string"
},
{
+ "description": "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": "tag value",
"name": "value",
"type": "string"
@@ -94963,85 +96614,9 @@
"type": "list"
},
{
- "description": "VPC the network belongs to",
- "name": "vpcid",
+ "description": "the name of the network",
+ "name": "name",
"type": "string"
- },
- {
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "the first DNS for the network",
- "name": "dns1",
- "type": "string"
- },
- {
- "description": "the name of the zone the network belongs to",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "an optional field, whether to the display the network to the end user or not.",
- "name": "displaynetwork",
- "type": "boolean"
- },
- {
- "description": "the type of the network",
- "name": "type",
- "type": "string"
- },
- {
- "description": "the traffic type of the network",
- "name": "traffictype",
- "type": "string"
- },
- {
- "description": "state of the network",
- "name": "state",
- "type": "string"
- },
- {},
- {
- "description": "true if network can span multiple zones",
- "name": "strechedl2subnet",
- "type": "boolean"
- },
- {
- "description": "the project id of the ipaddress",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the network's netmask",
- "name": "netmask",
- "type": "string"
- },
- {
- "description": "the network's gateway",
- "name": "gateway",
- "type": "string"
- },
- {
- "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR",
- "name": "cidr",
- "type": "string"
- },
- {
- "description": "the details of the network",
- "name": "details",
- "type": "map"
- },
- {
- "description": "display text of the network offering the network is created from",
- "name": "networkofferingdisplaytext",
- "type": "string"
- },
- {
- "description": "true if network supports specifying ip ranges, false otherwise",
- "name": "specifyipranges",
- "type": "boolean"
}
],
"since": "4.11.0"
@@ -95052,13 +96627,6 @@
"name": "addVmwareDc",
"params": [
{
- "description": "The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.",
- "length": 255,
- "name": "vcenter",
- "required": true,
- "type": "string"
- },
- {
"description": "The password for specified username.",
"length": 255,
"name": "password",
@@ -95066,6 +96634,13 @@
"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": true,
+ "type": "string"
+ },
+ {
"description": "The Username required to connect to resource.",
"length": 255,
"name": "username",
@@ -95090,37 +96665,37 @@
],
"related": "",
"response": [
+ {
+ "description": "The VMware Datacenter ID",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the Zone ID associated with this VMware Datacenter",
+ "name": "zoneid",
+ "type": "long"
+ },
{},
{
+ "description": "The VMware Datacenter name",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
"description": "The VMware vCenter name/ip",
"name": "vcenter",
"type": "string"
},
{},
{
- "description": "the Zone ID associated with this VMware Datacenter",
- "name": "zoneid",
- "type": "long"
- },
- {
- "description": "The VMware Datacenter ID",
- "name": "id",
- "type": "string"
- },
- {
- "description": "The VMware Datacenter name",
- "name": "name",
- "type": "string"
- },
- {
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
}
]
},
@@ -95130,11 +96705,12 @@
"name": "listUnmanagedInstances",
"params": [
{
- "description": "",
+ "description": "the cluster ID",
"length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
+ "name": "clusterid",
+ "related": "addCluster",
+ "required": true,
+ "type": "uuid"
},
{
"description": "List by keyword",
@@ -95144,12 +96720,18 @@
"type": "string"
},
{
- "description": "the cluster ID",
+ "description": "the hypervisor name of the instance",
"length": 255,
- "name": "clusterid",
- "related": "addCluster",
- "required": true,
- "type": "uuid"
+ "name": "name",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
},
{
"description": "",
@@ -95157,49 +96739,62 @@
"name": "page",
"required": false,
"type": "integer"
- },
- {
- "description": "the hypervisor name of the instance",
- "length": 255,
- "name": "name",
- "required": false,
- "type": "string"
}
],
"related": "",
"response": [
{
- "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 operating system of the virtual machine",
- "name": "osdisplayname",
- "type": "string"
- },
- {
- "description": "the CPU cores per socket for the virtual machine. VMware specific",
- "name": "cpucorepersocket",
- "type": "integer"
- },
- {
- "description": "the CPU speed of the virtual machine",
- "name": "cpuspeed",
- "type": "integer"
- },
- {
"description": "the list of nics associated with the virtual machine",
"name": "nic",
"response": [
{
- "description": "the netmask of the nic",
- "name": "netmask",
+ "description": "the IPv6 address of network",
+ "name": "ip6address",
+ "type": "string"
+ },
+ {
+ "description": "the gateway of the nic",
+ "name": "gateway",
+ "type": "string"
+ },
+ {
+ "description": "the traffic type of the nic",
+ "name": "traffictype",
+ "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 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": "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"
},
{
@@ -95208,13 +96803,48 @@
"type": "integer"
},
{
- "description": "the gateway of the nic",
- "name": "gateway",
+ "description": "the isolated private VLAN if available",
+ "name": "isolatedpvlan",
+ "type": "integer"
+ },
+ {
+ "description": "the ip address of the nic",
+ "name": "ipaddress",
"type": "string"
},
{
- "description": "Id of the NSX Logical Switch (if NSX based), null otherwise",
- "name": "nsxlogicalswitch",
+ "description": "the gateway of IPv6 network",
+ "name": "ip6gateway",
+ "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 isolation uri of the nic",
+ "name": "isolationuri",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the corresponding network",
+ "name": "networkid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the nic",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "Id of the vm to which the nic belongs",
+ "name": "virtualmachineid",
"type": "string"
},
{
@@ -95228,63 +96858,13 @@
"type": "string"
},
{
- "description": "the Secondary ipv4 addr of nic",
- "name": "secondaryip",
- "type": "list"
- },
- {
- "description": "the ID of the corresponding network",
- "name": "networkid",
- "type": "string"
- },
- {
- "description": "Id of the vm to which the nic belongs",
- "name": "virtualmachineid",
- "type": "string"
- },
- {
"description": "IP addresses associated with NIC found for unmanaged VM",
"name": "ipaddresses",
"type": "list"
},
{
- "description": "the 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 name of the corresponding network",
- "name": "networkname",
- "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 extra dhcp options on the nic",
- "name": "extradhcpoption",
- "type": "list"
- },
- {
- "description": "the gateway of IPv6 network",
- "name": "ip6gateway",
+ "description": "the cidr of IPv6 network",
+ "name": "ip6cidr",
"type": "string"
},
{
@@ -95293,49 +96873,95 @@
"type": "boolean"
},
{
- "description": "the traffic type of the nic",
- "name": "traffictype",
- "type": "string"
- },
- {
- "description": "Type of adapter if available",
- "name": "adaptertype",
- "type": "string"
- },
- {
- "description": "true if nic is default, false otherwise",
- "name": "macaddress",
- "type": "string"
- },
- {
- "description": "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 isolation uri of the nic",
- "name": "isolationuri",
- "type": "string"
- },
- {
- "description": "the cidr of IPv6 network",
- "name": "ip6cidr",
+ "description": "the netmask of the nic",
+ "name": "netmask",
"type": "string"
}
],
"type": "set"
},
{
+ "description": "the ID of the cluster to which virtual machine belongs",
+ "name": "clusterid",
+ "type": "string"
+ },
+ {
+ "description": "the operating system ID of the virtual machine",
+ "name": "osid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the host to which virtual machine belongs",
+ "name": "hostid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the host to which virtual machine belongs",
+ "name": "hostname",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the operating system of the virtual machine",
+ "name": "osdisplayname",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the CPU cores per socket for the virtual machine. VMware specific",
+ "name": "cpucorepersocket",
+ "type": "integer"
+ },
+ {
"description": "the list of disks associated with the virtual machine",
"name": "disk",
"response": [
{
"description": "the controller of the disk",
+ "name": "datastorepath",
+ "type": "string"
+ },
+ {
+ "description": "the position of the disk",
+ "name": "position",
+ "type": "integer"
+ },
+ {
+ "description": "the controller unit of the disk",
+ "name": "controllerunit",
+ "type": "integer"
+ },
+ {
+ "description": "the controller of the disk",
+ "name": "datastoretype",
+ "type": "string"
+ },
+ {
+ "description": "the label of the disk",
+ "name": "label",
+ "type": "string"
+ },
+ {
+ "description": "the capacity of the disk in bytes",
+ "name": "capacity",
+ "type": "long"
+ },
+ {
+ "description": "the controller of the disk",
+ "name": "controller",
+ "type": "string"
+ },
+ {
+ "description": "the file path of the disk image",
+ "name": "imagepath",
+ "type": "string"
+ },
+ {
+ "description": "the controller of the disk",
"name": "datastorehost",
"type": "string"
},
@@ -95345,85 +96971,34 @@
"type": "string"
},
{
- "description": "the controller of the disk",
- "name": "controller",
- "type": "string"
- },
- {
- "description": "the label of the disk",
- "name": "label",
- "type": "string"
- },
- {
- "description": "the controller unit of the disk",
- "name": "controllerunit",
- "type": "integer"
- },
- {
- "description": "the capacity of the disk in bytes",
- "name": "capacity",
- "type": "long"
- },
- {
- "description": "the position of the disk",
- "name": "position",
- "type": "integer"
- },
- {
"description": "the ID of the disk",
"name": "id",
"type": "string"
- },
- {
- "description": "the file path of the disk image",
- "name": "imagepath",
- "type": "string"
- },
- {
- "description": "the controller of the disk",
- "name": "datastoretype",
- "type": "string"
- },
- {
- "description": "the controller of the disk",
- "name": "datastorepath",
- "type": "string"
}
],
"type": "set"
},
- {},
{
- "description": "the ID of the cluster to which virtual machine belongs",
- "name": "clusterid",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
+ "description": "the CPU speed of the virtual machine",
+ "name": "cpuspeed",
"type": "integer"
},
{
- "description": "the ID of the host to which virtual machine belongs",
- "name": "hostid",
- "type": "string"
- },
- {},
- {
- "description": "the name of the virtual machine",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the operating system ID of the virtual machine",
- "name": "osid",
- "type": "string"
- },
- {
"description": "the CPU cores of the virtual machine",
"name": "cpunumber",
"type": "integer"
},
+ {},
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the virtual machine",
+ "name": "name",
+ "type": "string"
+ },
{
"description": "the power state of the virtual machine",
"name": "powerstate",
@@ -95443,21 +97018,6 @@
"name": "updateIsoPermissions",
"params": [
{
- "description": "a comma delimited list of accounts within caller's domain. If specified, \"op\" parameter has to be passed in.",
- "length": 255,
- "name": "accounts",
- "required": false,
- "type": "list"
- },
- {
- "description": "the template ID",
- "length": 255,
- "name": "id",
- "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos",
- "required": true,
- "type": "uuid"
- },
- {
"description": "a comma delimited list of projects. If specified, \"op\" parameter has to be passed in.",
"length": 255,
"name": "projectids",
@@ -95466,16 +97026,23 @@
"type": "list"
},
{
- "description": "true for featured template/iso, false otherwise",
+ "description": "true if the template/iso is extractable, false other wise. Can be set only by root admin",
"length": 255,
- "name": "isfeatured",
+ "name": "isextractable",
"required": false,
"type": "boolean"
},
{
- "description": "true if the template/iso is extractable, false other wise. Can be set only by root admin",
+ "description": "a comma delimited list of accounts within caller's domain. If specified, \"op\" parameter has to be passed in.",
"length": 255,
- "name": "isextractable",
+ "name": "accounts",
+ "required": false,
+ "type": "list"
+ },
+ {
+ "description": "true for featured template/iso, false otherwise",
+ "length": 255,
+ "name": "isfeatured",
"required": false,
"type": "boolean"
},
@@ -95492,13 +97059,21 @@
"name": "op",
"required": false,
"type": "string"
+ },
+ {
+ "description": "the template ID",
+ "length": 255,
+ "name": "id",
+ "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos",
+ "required": true,
+ "type": "uuid"
}
],
"response": [
{
- "description": "any text associated with the success or failure",
- "name": "displaytext",
- "type": "string"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
{
"description": "the UUID of the latest async job acting on this object",
@@ -95506,17 +97081,17 @@
"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"
+ }
]
},
{
@@ -95532,70 +97107,6 @@
"type": "string"
},
{
- "description": "the ID of the OS Type that best represents the OS of this template. Not applicable with VMware, as we honour what is defined in the template",
- "length": 255,
- "name": "ostypeid",
- "related": "",
- "required": false,
- "type": "uuid"
- },
- {
- "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 display text of the template. This is usually used for display purposes.",
- "length": 4096,
- "name": "displaytext",
- "required": true,
- "type": "string"
- },
- {
- "description": "the target hypervisor for the template",
- "length": 255,
- "name": "hypervisor",
- "required": true,
- "type": "string"
- },
- {
- "description": "true if the template supports the password reset feature; default is false",
- "length": 255,
- "name": "passwordenabled",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "the checksum value of this template. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{<algorithm>}\", not including the double quotes. In this <algorithm> is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.",
- "length": 255,
- "name": "checksum",
- "required": false,
- "type": "string"
- },
- {
- "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61",
- "length": 255,
- "name": "details",
- "required": false,
- "type": "map"
- },
- {
- "description": "true if the template type is routing i.e., if template is used to deploy router",
- "length": 255,
- "name": "isrouting",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "the name of the template",
- "length": 255,
- "name": "name",
- "required": true,
- "type": "string"
- },
- {
"description": "true if the template supports the sshkey upload feature; default is false",
"length": 255,
"name": "sshkeyenabled",
@@ -95611,13 +97122,34 @@
"type": "boolean"
},
{
- "description": "true if the template is available to all accounts; default is true",
+ "description": "true if the template or its derivatives are extractable; default is false",
"length": 255,
- "name": "ispublic",
+ "name": "isextractable",
"required": false,
"type": "boolean"
},
{
+ "description": "an optional accountName. Must be used with domainId.",
+ "length": 255,
+ "name": "account",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "32 or 64 bits support. 64 by default",
+ "length": 255,
+ "name": "bits",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "the name of the template",
+ "length": 255,
+ "name": "name",
+ "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",
@@ -95626,13 +97158,6 @@
"type": "list"
},
{
- "description": "true if the template or its derivatives are extractable; default is false",
- "length": 255,
- "name": "isextractable",
- "required": false,
- "type": "boolean"
- },
- {
"description": "an optional domainId. If the account parameter is used, domainId must also be used.",
"length": 255,
"name": "domainid",
@@ -95641,6 +97166,21 @@
"type": "uuid"
},
{
+ "description": "true if the template supports the password reset feature; default is false",
+ "length": 255,
+ "name": "passwordenabled",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "the ID of the OS Type that best represents the OS of this template. Not applicable with VMware, as we honour what is defined in the template",
+ "length": 255,
+ "name": "ostypeid",
+ "related": "",
+ "required": false,
+ "type": "uuid"
+ },
+ {
"description": "true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment",
"length": 255,
"name": "directdownload",
@@ -95648,11 +97188,25 @@
"type": "boolean"
},
{
- "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 display text of the template. This is usually used for display purposes.",
+ "length": 4096,
+ "name": "displaytext",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "the checksum value of this template. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{<algorithm>}\", not including the double quotes. In this <algorithm> is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.",
+ "length": 255,
+ "name": "checksum",
+ "required": false,
+ "type": "string"
},
{
"description": "true if this template requires HVM",
@@ -95662,36 +97216,6 @@
"type": "boolean"
},
{
- "description": "the ID of the zone the template is to be hosted on",
- "length": 255,
- "name": "zoneid",
- "related": "createZone,listZones",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "Register template for the project",
- "length": 255,
- "name": "projectid",
- "related": "activateProject",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "the URL of where the template is hosted. Possible URL include http:// and https://",
- "length": 2048,
- "name": "url",
- "required": true,
- "type": "string"
- },
- {
- "description": "true if this template is a featured template, false otherwise",
- "length": 255,
- "name": "isfeatured",
- "required": false,
- "type": "boolean"
- },
- {
"description": "the tag for this template.",
"length": 255,
"name": "templatetag",
@@ -95699,24 +97223,75 @@
"type": "string"
},
{
- "description": "an optional accountName. Must be used with domainId.",
+ "description": "the target hypervisor for the template",
"length": 255,
- "name": "account",
- "required": false,
+ "name": "hypervisor",
+ "required": true,
"type": "string"
+ },
+ {
+ "description": "true if this template is a featured template, false otherwise",
+ "length": 255,
+ "name": "isfeatured",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61",
+ "length": 255,
+ "name": "details",
+ "required": false,
+ "type": "map"
+ },
+ {
+ "description": "the ID of the zone the template is to be hosted on",
+ "length": 255,
+ "name": "zoneid",
+ "related": "createZone,listZones",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "the URL of where the template is hosted. Possible URL include http:// and https://",
+ "length": 2048,
+ "name": "url",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory",
+ "length": 255,
+ "name": "isdynamicallyscalable",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "true if the template is available to all accounts; default is true",
+ "length": 255,
+ "name": "ispublic",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "Register template for the project",
+ "length": 255,
+ "name": "projectid",
+ "related": "activateProject",
+ "required": false,
+ "type": "uuid"
}
],
"related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos",
"response": [
{
- "description": "the name of the domain to which the template belongs",
- "name": "domain",
- "type": "string"
+ "description": "true if template requires HVM enabled, false otherwise",
+ "name": "requireshvm",
+ "type": "boolean"
},
{
- "description": "the template name",
- "name": "name",
- "type": "string"
+ "description": "true if this template is a public template, false otherwise",
+ "name": "ispublic",
+ "type": "boolean"
},
{
"description": "the tag of this template",
@@ -95724,186 +97299,28 @@
"type": "string"
},
{
- "description": "the physical size of the template",
- "name": "physicalsize",
- "type": "long"
- },
- {
- "description": "the list of resource tags associated",
- "name": "tags",
- "response": [
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "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 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 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"
- }
- ],
- "type": "set"
- },
- {
- "description": "the template ID",
- "name": "id",
+ "description": "the ID of the domain to which the template belongs",
+ "name": "domainid",
"type": "string"
},
{
- "description": "VMware only: additional key/value details tied with deploy-as-is template",
- "name": "deployasisdetails",
- "type": "map"
- },
- {
- "description": "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 type of the template",
- "name": "templatetype",
- "type": "string"
- },
- {
- "description": "true if the template is managed across all Zones, false otherwise",
- "name": "crossZones",
+ "description": "true if the 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": "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": "true if template is sshkey enabled, false otherwise",
- "name": "sshkeyenabled",
- "type": "boolean"
- },
- {
- "description": "the format of the template.",
- "name": "format",
- "type": "imageformat"
- },
- {
- "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage",
- "name": "directdownload",
- "type": "boolean"
- },
- {
- "description": "the name of the OS type for this template.",
- "name": "ostypename",
+ "description": "the name of the domain to which the template belongs",
+ "name": "domain",
"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": "the date this template was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "if root disk template, then ids of the datas disk templates this template owns",
- "name": "childtemplates",
- "type": "set"
- },
- {
- "description": "the ID of the zone for this template",
- "name": "zoneid",
- "type": "string"
- },
- {},
- {
- "description": "the name of the secondary storage host for the template",
- "name": "hostname",
- "type": "string"
- },
- {
- "description": "true if the ISO is bootable, false otherwise",
- "name": "bootable",
- "type": "boolean"
- },
- {
- "description": "the date this template was removed",
- "name": "removed",
- "type": "date"
- },
- {
- "description": "the ID of the OS type for this template.",
- "name": "ostypeid",
- "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": "the status of the template",
- "name": "status",
+ "description": "the hypervisor on which the template runs",
+ "name": "hypervisor",
"type": "string"
},
{
@@ -95917,69 +97334,28 @@
"type": "string"
},
{
- "description": "true if the reset password feature is enabled, false otherwise",
- "name": "passwordenabled",
- "type": "boolean"
- },
- {
- "description": "the account id to which the template belongs",
- "name": "accountid",
- "type": "string"
- },
- {
- "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 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": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the ID of the domain to which the template belongs",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "true if template requires HVM enabled, false otherwise",
- "name": "requireshvm",
- "type": "boolean"
- },
- {},
- {
"description": "the template ID of the parent template if present",
"name": "sourcetemplateid",
"type": "string"
},
{
+ "description": "if Datadisk template, then id of the root disk template this template belongs to",
+ "name": "parenttemplateid",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
"description": "the project name of the template",
"name": "project",
"type": "string"
},
{
- "description": "the project id of the template",
- "name": "projectid",
+ "description": "the ID of the secondary storage host for the template",
+ "name": "hostid",
"type": "string"
},
{
@@ -95988,8 +97364,58 @@
"type": "string"
},
{
- "description": "the name of the zone for this template",
- "name": "zonename",
+ "description": "the physical size of the template",
+ "name": "physicalsize",
+ "type": "long"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "Lists the download progress of a template across all secondary storages",
+ "name": "downloaddetails",
+ "type": "list"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the OS type for this template.",
+ "name": "ostypename",
+ "type": "string"
+ },
+ {
+ "description": "additional key/value details tied with template",
+ "name": "details",
+ "type": "map"
+ },
+ {
+ "description": "the status of the template",
+ "name": "status",
+ "type": "string"
+ },
+ {
+ "description": "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": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "description": "the type of the template",
+ "name": "templatetype",
"type": "string"
},
{
@@ -95997,19 +97423,168 @@
"name": "isdynamicallyscalable",
"type": "boolean"
},
+ {},
+ {
+ "description": "the list of resource tags associated",
+ "name": "tags",
+ "response": [
+ {
+ "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": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the 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": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the date this template was removed",
+ "name": "removed",
+ "type": "date"
+ },
+ {
+ "description": "true if the ISO is bootable, false otherwise",
+ "name": "bootable",
+ "type": "boolean"
+ },
+ {
+ "description": "the date this template was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the account id to which the template belongs",
+ "name": "accountid",
+ "type": "string"
+ },
+ {
+ "description": "VMware only: additional key/value details tied with deploy-as-is template",
+ "name": "deployasisdetails",
+ "type": "map"
+ },
+ {
+ "description": "true if the template is extractable, false otherwise",
+ "name": "isextractable",
+ "type": "boolean"
+ },
+ {
+ "description": "the name of the zone for this template",
+ "name": "zonename",
+ "type": "string"
+ },
{
"description": "the URL which the template/iso is registered from",
"name": "url",
"type": "string"
},
{
- "description": "true if the template is ready to be deployed from, false otherwise.",
- "name": "isready",
+ "description": "the ID of the OS type for this template.",
+ "name": "ostypeid",
+ "type": "string"
+ },
+ {
+ "description": "the processor bit size",
+ "name": "bits",
+ "type": "int"
+ },
+ {
+ "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 format of the template.",
+ "name": "format",
+ "type": "imageformat"
+ },
+ {
+ "description": "the project id of the template",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the size of the template",
+ "name": "size",
+ "type": "long"
+ },
+ {
+ "description": "the name of the secondary storage host for the template",
+ "name": "hostname",
+ "type": "string"
+ },
+ {
+ "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",
+ "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 managed across all Zones, false otherwise",
+ "name": "crossZones",
+ "type": "boolean"
+ },
+ {
+ "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"
}
]
@@ -96035,18 +97610,18 @@
"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"
@@ -96059,17 +97634,9 @@
"name": "addStratosphereSsp",
"params": [
{
- "description": "the zone ID",
+ "description": "stratosphere ssp api password",
"length": 255,
- "name": "zoneid",
- "related": "createZone,listZones",
- "required": true,
- "type": "uuid"
- },
- {
- "description": "stratosphere ssp api username",
- "length": 255,
- "name": "username",
+ "name": "password",
"required": false,
"type": "string"
},
@@ -96081,30 +97648,42 @@
"type": "string"
},
{
- "description": "stratosphere ssp api password",
+ "description": "stratosphere ssp tenant uuid",
"length": 255,
- "name": "password",
+ "name": "tenantuuid",
"required": false,
"type": "string"
},
{
+ "description": "stratosphere ssp api username",
+ "length": 255,
+ "name": "username",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the zone ID",
+ "length": 255,
+ "name": "zoneid",
+ "related": "createZone,listZones",
+ "required": true,
+ "type": "uuid"
+ },
+ {
"description": "stratosphere ssp api name",
"length": 255,
"name": "name",
"required": true,
"type": "string"
- },
- {
- "description": "stratosphere ssp tenant uuid",
- "length": 255,
- "name": "tenantuuid",
- "required": false,
- "type": "string"
}
],
"related": "",
"response": [
- {},
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
{
"description": "zone which this ssp controls",
"name": "zoneid",
@@ -96121,20 +97700,16 @@
"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": "server id of the stratosphere ssp server",
"name": "hostid",
"type": "string"
},
+ {},
+ {
+ "description": "name",
+ "name": "name",
+ "type": "string"
+ },
{}
]
},
@@ -96154,15 +97729,11 @@
],
"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",
@@ -96170,11 +97741,15 @@
},
{},
{
+ "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"
- },
- {}
+ }
]
},
{
@@ -96183,28 +97758,6 @@
"name": "createStoragePool",
"params": [
{
- "description": "the tags for the storage pool",
- "length": 255,
- "name": "tags",
- "required": false,
- "type": "string"
- },
- {
- "description": "whether the storage should be managed by CloudStack",
- "length": 255,
- "name": "managed",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "the Zone ID for the storage pool",
- "length": 255,
- "name": "zoneid",
- "related": "createZone,listZones",
- "required": true,
- "type": "uuid"
- },
- {
"description": "bytes CloudStack can provision from this storage pool",
"length": 255,
"name": "capacitybytes",
@@ -96212,28 +97765,6 @@
"type": "long"
},
{
- "description": "the scope of the storage: cluster or zone",
- "length": 255,
- "name": "scope",
- "required": false,
- "type": "string"
- },
- {
- "description": "the Pod ID for the storage pool",
- "length": 255,
- "name": "podid",
- "related": "updatePod,createManagementNetworkIpRange",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "the URL of the storage pool",
- "length": 255,
- "name": "url",
- "required": true,
- "type": "string"
- },
- {
"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": "hypervisor",
@@ -96241,6 +97772,13 @@
"type": "string"
},
{
+ "description": "the tags for the storage pool",
+ "length": 255,
+ "name": "tags",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "the details for the storage pool",
"length": 255,
"name": "details",
@@ -96255,13 +97793,42 @@
"type": "long"
},
{
- "description": "the storage provider name",
+ "description": "the Zone ID for the storage pool",
"length": 255,
- "name": "provider",
+ "name": "zoneid",
+ "related": "createZone,listZones",
+ "required": true,
+ "type": "uuid"
+ },
+ {
+ "description": "the URL of the storage pool",
+ "length": 255,
+ "name": "url",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "the scope of the storage: cluster or zone",
+ "length": 255,
+ "name": "scope",
"required": false,
"type": "string"
},
{
+ "description": "the name for the storage pool",
+ "length": 255,
+ "name": "name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "whether the storage should be managed by CloudStack",
+ "length": 255,
+ "name": "managed",
+ "required": false,
+ "type": "boolean"
+ },
+ {
"description": "the cluster ID for the storage pool",
"length": 255,
"name": "clusterid",
@@ -96270,135 +97837,57 @@
"type": "uuid"
},
{
- "description": "the name for the storage pool",
+ "description": "the storage provider name",
"length": 255,
- "name": "name",
- "required": true,
+ "name": "provider",
+ "required": false,
"type": "string"
+ },
+ {
+ "description": "the Pod ID for the storage pool",
+ "length": 255,
+ "name": "podid",
+ "related": "updatePod,createManagementNetworkIpRange",
+ "required": false,
+ "type": "uuid"
}
],
"related": "cancelStorageMaintenance,findStoragePoolsForMigration,enableStorageMaintenance",
"response": [
{
- "description": "the state of the storage pool",
- "name": "state",
- "type": "storagepoolstatus"
- },
- {
- "description": "the total disk size of the storage pool",
- "name": "disksizetotal",
- "type": "long"
- },
- {
- "description": "the name of the cluster for the storage pool",
- "name": "clustername",
- "type": "string"
- },
- {
- "description": "the storage pool type",
- "name": "type",
- "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 ID of the storage pool",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the Pod ID of the storage pool",
- "name": "podid",
- "type": "string"
- },
- {},
- {
- "description": "the Zone name of the storage pool",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "the hypervisor type of the storage pool",
- "name": "hypervisor",
- "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": "IOPS CloudStack can provision from this storage pool",
- "name": "capacityiops",
+ "description": "the tags for the storage pool",
+ "name": "tags",
+ "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 IP address of the storage pool",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "description": "the host's currently allocated disk size",
- "name": "disksizeallocated",
- "type": "long"
- },
- {
- "description": "Storage provider for this pool",
- "name": "provider",
- "type": "string"
- },
- {
- "description": "the storage pool path",
- "name": "path",
- "type": "string"
- },
- {
- "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": "the Zone ID of the storage pool",
- "name": "zoneid",
- "type": "string"
- },
- {
"description": "the scope of the storage pool",
"name": "scope",
"type": "string"
},
{
- "description": "the overprovisionfactor for the storage pool",
- "name": "overprovisionfactor",
- "type": "string"
+ "description": "the state of the storage pool",
+ "name": "state",
+ "type": "storagepoolstatus"
},
{
- "description": "the name of the storage pool",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the ID of the cluster for the storage pool",
- "name": "clusterid",
+ "description": "the storage pool type",
+ "name": "type",
"type": "string"
},
{
@@ -96407,19 +97896,105 @@
"type": "boolean"
},
{
+ "description": "the name of the storage pool",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the storage pool",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the name of the cluster for the storage pool",
+ "name": "clustername",
+ "type": "string"
+ },
+ {
+ "description": "the hypervisor type of the storage pool",
+ "name": "hypervisor",
+ "type": "string"
+ },
+ {
+ "description": "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 Pod ID of the storage pool",
+ "name": "podid",
+ "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 this pool is suitable to migrate a volume, false otherwise",
"name": "suitableformigration",
"type": "boolean"
},
{
- "description": "the host's currently used disk size",
- "name": "disksizeused",
+ "description": "the storage pool path",
+ "name": "path",
+ "type": "string"
+ },
+ {
+ "description": "the IP address of the storage pool",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "the total disk size of the storage pool",
+ "name": "disksizetotal",
"type": "long"
},
{
"description": "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 ID of the cluster for the storage pool",
+ "name": "clusterid",
+ "type": "string"
+ },
+ {
+ "description": "IOPS CloudStack can provision from this storage pool",
+ "name": "capacityiops",
+ "type": "long"
+ },
+ {},
+ {
+ "description": "the Zone name of the storage pool",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "Storage provider for this pool",
+ "name": "provider",
+ "type": "string"
}
]
},
@@ -96429,20 +98004,6 @@
"name": "findStoragePoolsForMigration",
"params": [
{
- "description": "",
- "length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
- },
- {
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
- },
- {
"description": "the ID of the volume",
"length": 255,
"name": "id",
@@ -96456,33 +98017,27 @@
"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": "cancelStorageMaintenance,enableStorageMaintenance",
"response": [
{
- "description": "the storage pool type",
- "name": "type",
- "type": "string"
- },
- {
- "description": "the hypervisor type of the storage pool",
- "name": "hypervisor",
- "type": "string"
- },
- {
- "description": "the Zone ID of the storage pool",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "IOPS CloudStack can provision from this storage pool",
- "name": "capacityiops",
- "type": "long"
- },
- {
- "description": "the overprovisionfactor for the storage pool",
- "name": "overprovisionfactor",
+ "description": "the scope of the storage pool",
+ "name": "scope",
"type": "string"
},
{
@@ -96491,38 +98046,45 @@
"type": "string"
},
{
- "description": "the host's currently allocated disk size",
- "name": "disksizeallocated",
- "type": "long"
- },
- {
- "description": "the Pod name of the storage pool",
- "name": "podname",
+ "description": "the storage pool type",
+ "name": "type",
"type": "string"
},
{
- "description": "the host's currently used disk size",
- "name": "disksizeused",
- "type": "long"
- },
- {
"description": "true if this pool is suitable to migrate a volume, false otherwise",
"name": "suitableformigration",
"type": "boolean"
},
{
- "description": "the ID of the cluster for the storage pool",
- "name": "clusterid",
+ "description": "the date and time the storage pool was created",
+ "name": "created",
+ "type": "date"
+ },
+ {},
+ {
+ "description": "total min IOPS currently in use by volumes",
+ "name": "allocatediops",
+ "type": "long"
+ },
+ {
+ "description": "the overprovisionfactor for the storage pool",
+ "name": "overprovisionfactor",
"type": "string"
},
{
- "description": "the Zone name of the storage pool",
- "name": "zonename",
+ "description": "the name of the cluster for the storage pool",
+ "name": "clustername",
"type": "string"
},
+ {},
{
- "description": "the Pod ID of the storage pool",
- "name": "podid",
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the Pod name of the storage pool",
+ "name": "podname",
"type": "string"
},
{
@@ -96530,25 +98092,19 @@
"name": "id",
"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 total disk size of the storage pool",
- "name": "disksizetotal",
- "type": "long"
+ "description": "the storage pool path",
+ "name": "path",
+ "type": "string"
},
{
- "description": "the date and time the storage pool was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "total min IOPS currently in use by volumes",
- "name": "allocatediops",
+ "description": "IOPS CloudStack can provision from this storage pool",
+ "name": "capacityiops",
"type": "long"
},
{
@@ -96556,20 +98112,34 @@
"name": "state",
"type": "storagepoolstatus"
},
- {},
+ {
+ "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 Zone name of the storage pool",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "the host's currently allocated disk size",
+ "name": "disksizeallocated",
+ "type": "long"
+ },
+ {
"description": "the storage pool capabilities",
"name": "storagecapabilities",
"type": "map"
},
{
- "description": "Storage provider for this pool",
- "name": "provider",
+ "description": "the name of the storage pool",
+ "name": "name",
"type": "string"
},
{
@@ -96578,29 +98148,34 @@
"type": "string"
},
{
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
+ "description": "the ID of the cluster for the storage pool",
+ "name": "clusterid",
+ "type": "string"
},
{
- "description": "the scope of the storage pool",
- "name": "scope",
+ "description": "the total disk size of the storage pool",
+ "name": "disksizetotal",
+ "type": "long"
+ },
+ {
+ "description": "the Pod ID of the storage pool",
+ "name": "podid",
+ "type": "string"
+ },
+ {
+ "description": "the host's currently used disk size",
+ "name": "disksizeused",
+ "type": "long"
+ },
+ {
+ "description": "the Zone ID of the storage pool",
+ "name": "zoneid",
"type": "string"
},
{
"description": "the IP address of the storage pool",
"name": "ipaddress",
"type": "string"
- },
- {
- "description": "the name of the storage pool",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the storage pool path",
- "name": "path",
- "type": "string"
}
]
},
@@ -96610,6 +98185,13 @@
"name": "addOpenDaylightController",
"params": [
{
+ "description": "Api URL of the OpenDaylight Controller.",
+ "length": 255,
+ "name": "url",
+ "required": true,
+ "type": "string"
+ },
+ {
"description": "Credential to access the OpenDaylight API",
"length": 255,
"name": "password",
@@ -96617,26 +98199,19 @@
"type": "string"
},
{
+ "description": "Username to access the OpenDaylight API",
+ "length": 255,
+ "name": "username",
+ "required": true,
+ "type": "string"
+ },
+ {
"description": "the Physical Network ID",
"length": 255,
"name": "physicalnetworkid",
"related": "createPhysicalNetwork",
"required": true,
"type": "uuid"
- },
- {
- "description": "Api URL of the OpenDaylight Controller.",
- "length": 255,
- "name": "url",
- "required": true,
- "type": "string"
- },
- {
- "description": "Username to access the OpenDaylight API",
- "length": 255,
- "name": "username",
- "required": true,
- "type": "string"
}
],
"related": "",
@@ -96646,36 +98221,36 @@
"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 controller belongs to",
"name": "physicalnetworkid",
"type": "string"
},
+ {},
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {},
+ {
+ "description": "the username to authenticate to the controller",
+ "name": "username",
+ "type": "string"
+ },
+ {
+ "description": "device id of the controller",
+ "name": "id",
+ "type": "string"
+ },
{
"description": "the name assigned to the controller",
"name": "name",
"type": "string"
},
{
- "description": "the username to authenticate to the controller",
- "name": "username",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "device id of the controller",
- "name": "id",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
}
]
@@ -96686,13 +98261,41 @@
"name": "createZone",
"params": [
{
- "description": "the first DNS for the Zone",
+ "description": "the first internal DNS for the Zone",
"length": 255,
- "name": "dns1",
+ "name": "internaldns1",
"required": true,
"type": "string"
},
{
+ "description": "the guest CIDR address for the Zone",
+ "length": 255,
+ "name": "guestcidraddress",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the second DNS for IPv6 network in the Zone",
+ "length": 255,
+ "name": "ip6dns2",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "network type of the zone, can be Basic or Advanced",
+ "length": 255,
+ "name": "networktype",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "the second internal DNS for the Zone",
+ "length": 255,
+ "name": "internaldns2",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "the second DNS for the Zone",
"length": 255,
"name": "dns2",
@@ -96707,16 +98310,9 @@
"type": "string"
},
{
- "description": "the guest CIDR address for the Zone",
+ "description": "the first DNS for the Zone",
"length": 255,
- "name": "guestcidraddress",
- "required": false,
- "type": "string"
- },
- {
- "description": "network type of the zone, can be Basic or Advanced",
- "length": 255,
- "name": "networktype",
+ "name": "dns1",
"required": true,
"type": "string"
},
@@ -96729,37 +98325,9 @@
"type": "uuid"
},
{
- "description": "the name of the Zone",
+ "description": "Network domain name for the networks in the zone",
"length": 255,
- "name": "name",
- "required": true,
- "type": "string"
- },
- {
- "description": "the first internal DNS for the Zone",
- "length": 255,
- "name": "internaldns1",
- "required": true,
- "type": "string"
- },
- {
- "description": "the second internal DNS for the Zone",
- "length": 255,
- "name": "internaldns2",
- "required": false,
- "type": "string"
- },
- {
- "description": "the second DNS for IPv6 network in the Zone",
- "length": 255,
- "name": "ip6dns2",
- "required": false,
- "type": "string"
- },
- {
- "description": "the first DNS for IPv6 network in the Zone",
- "length": 255,
- "name": "ip6dns1",
+ "name": "domain",
"required": false,
"type": "string"
},
@@ -96778,9 +98346,16 @@
"type": "boolean"
},
{
- "description": "Network domain name for the networks in the zone",
+ "description": "the name of the Zone",
"length": 255,
- "name": "domain",
+ "name": "name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "the first DNS for IPv6 network in the Zone",
+ "length": 255,
+ "name": "ip6dns1",
"required": false,
"type": "string"
}
@@ -96788,33 +98363,28 @@
"related": "listZones",
"response": [
{
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
- },
- {
- "description": "the second IPv6 DNS for the Zone",
- "name": "ip6dns2",
+ "description": "the UUID of the containing domain, null for public zones",
+ "name": "domainid",
"type": "string"
},
{
- "description": "the second internal DNS for the Zone",
- "name": "internaldns2",
+ "description": "true if local storage offering enabled, false otherwise",
+ "name": "localstorageenabled",
+ "type": "boolean"
+ },
+ {
+ "description": "the name of the containing domain, null for public zones",
+ "name": "domainname",
"type": "string"
},
{
- "description": "Meta data associated with the zone (key/value pairs)",
- "name": "resourcedetails",
- "type": "map"
- },
- {
- "description": "the first internal DNS for the Zone",
- "name": "internaldns1",
+ "description": "Zone id",
+ "name": "id",
"type": "string"
},
{
- "description": "Zone Token",
- "name": "zonetoken",
+ "description": "the allocation state of the cluster",
+ "name": "allocationstate",
"type": "string"
},
{
@@ -96823,127 +98393,20 @@
"type": "string"
},
{
- "description": "Zone description",
- "name": "description",
- "type": "string"
- },
- {
- "description": "the name of the containing domain, null for public zones",
- "name": "domainname",
- "type": "string"
- },
- {
- "description": "the first DNS for the Zone",
- "name": "dns1",
- "type": "string"
- },
- {
- "description": "the capacity of the Zone",
- "name": "capacity",
- "response": [
- {
- "description": "the capacity name",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the capacity type",
- "name": "type",
- "type": "short"
- },
- {
- "description": "the Zone ID",
- "name": "zoneid",
- "type": "string"
- },
- {
- "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 Cluster name",
- "name": "clustername",
- "type": "string"
- },
- {
- "description": "the Pod name",
- "name": "podname",
- "type": "string"
- },
- {
- "description": "the Cluster ID",
- "name": "clusterid",
- "type": "string"
- },
- {
- "description": "the total capacity available",
- "name": "capacitytotal",
- "type": "long"
- },
- {
- "description": "the Pod ID",
- "name": "podid",
- "type": "string"
- },
- {
- "description": "the capacity currently in use",
- "name": "capacityused",
- "type": "long"
- }
- ],
- "type": "list"
- },
- {
"description": "the list of resource tags associated with zone.",
"name": "tags",
"response": [
{
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
"description": "id of the resource",
"name": "resourceid",
"type": "string"
},
{
- "description": "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": "tag key name",
"name": "key",
"type": "string"
@@ -96954,16 +98417,51 @@
"type": "string"
},
{
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
"description": "the ID of the domain associated with the tag",
"name": "domainid",
"type": "string"
+ },
+ {
+ "description": "the 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"
}
],
"type": "set"
},
{
- "description": "the first IPv6 DNS for the Zone",
- "name": "ip6dns1",
+ "description": "the first DNS for the Zone",
+ "name": "dns1",
+ "type": "string"
+ },
+ {
+ "description": "the network type of the zone; can be Basic or Advanced",
+ "name": "networktype",
+ "type": "string"
+ },
+ {
+ "description": "the second IPv6 DNS for the Zone",
+ "name": "ip6dns2",
"type": "string"
},
{
@@ -96971,15 +98469,55 @@
"name": "guestcidraddress",
"type": "string"
},
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the first internal DNS for the Zone",
+ "name": "internaldns1",
+ "type": "string"
+ },
{},
{
- "description": "the allocation state of the cluster",
- "name": "allocationstate",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
- "description": "Zone id",
- "name": "id",
+ "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": "the second internal DNS for the Zone",
+ "name": "internaldns2",
+ "type": "string"
+ },
+ {
+ "description": "Zone description",
+ "name": "description",
+ "type": "string"
+ },
+ {
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "description": "the first IPv6 DNS for the Zone",
+ "name": "ip6dns1",
+ "type": "string"
+ },
+ {
+ "description": "the display text of the zone",
+ "name": "displaytext",
"type": "string"
},
{
@@ -96992,30 +98530,11 @@
"name": "dhcpprovider",
"type": "string"
},
+ {},
{
- "description": "true if security groups support is enabled, false otherwise",
- "name": "securitygroupsenabled",
- "type": "boolean"
- },
- {
- "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"
- },
- {
- "description": "the display text of the zone",
- "name": "displaytext",
- "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)",
+ "name": "resourcedetails",
+ "type": "map"
},
{
"description": "the second DNS for the Zone",
@@ -97023,20 +98542,76 @@
"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",
+ "description": "true if security groups support is enabled, false otherwise",
+ "name": "securitygroupsenabled",
"type": "boolean"
},
- {},
{
- "description": "the network type of the zone; can be Basic or Advanced",
- "name": "networktype",
- "type": "string"
+ "description": "the capacity of the Zone",
+ "name": "capacity",
+ "response": [
+ {
+ "description": "the Zone name",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "the capacity name",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the Cluster name",
+ "name": "clustername",
+ "type": "string"
+ },
+ {
+ "description": "the capacity type",
+ "name": "type",
+ "type": "short"
+ },
+ {
+ "description": "the capacity currently in allocated",
+ "name": "capacityallocated",
+ "type": "long"
+ },
+ {
+ "description": "the Zone ID",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the Pod name",
+ "name": "podname",
+ "type": "string"
+ },
+ {
+ "description": "the total capacity available",
+ "name": "capacitytotal",
+ "type": "long"
+ },
+ {
+ "description": "the Pod ID",
+ "name": "podid",
+ "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 Cluster ID",
+ "name": "clusterid",
+ "type": "string"
+ }
+ ],
+ "type": "list"
}
]
},
@@ -97057,49 +98632,8 @@
"related": "listCiscoNexusVSMs",
"response": [
{
- "description": "packet vlan id of the VSM",
- "name": "vsmpktvlanid",
- "type": "int"
- },
- {},
- {
- "description": "device name",
- "name": "vsmdevicename",
- "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 UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "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": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module",
- "name": "ipaddress",
+ "description": "device id of the Cisco N1KV VSM device",
+ "name": "vsmdeviceid",
"type": "string"
},
{
@@ -97108,24 +98642,65 @@
"type": "string"
},
{
+ "description": "device state",
+ "name": "vsmdevicestate",
+ "type": "string"
+ },
+ {
"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",
+ "description": "storage vlan id of the VSM",
+ "name": "vsmstoragevlanid",
+ "type": "int"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
{},
{
+ "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
"description": "The Device State (Enabled/Disabled) of the VSM",
"name": "vsmdevicestate",
"type": "string"
},
{
- "description": "device id of the Cisco N1KV VSM device",
- "name": "vsmdeviceid",
+ "description": "The Config State (Primary/Standby) of the VSM",
+ "name": "vsmconfigstate",
+ "type": "string"
+ },
+ {
+ "description": "control vlan id of the VSM",
+ "name": "vsmctrlvlanid",
+ "type": "int"
+ },
+ {
+ "description": "device name",
+ "name": "vsmdevicename",
+ "type": "string"
+ },
+ {
+ "description": "packet vlan id of the VSM",
+ "name": "vsmpktvlanid",
+ "type": "int"
+ },
+ {},
+ {
+ "description": "management vlan id of the VSM",
+ "name": "vsmmgmtvlanid",
"type": "string"
}
]
@@ -97136,6 +98711,28 @@
"name": "createStorageNetworkIpRange",
"params": [
{
+ "description": "Optional. The vlan the ip range sits on, default to Null when it is not specificed which means you network is not on any Vlan. This is mainly for Vmware as other hypervisors can directly reterive bridge from pyhsical network traffic type table",
+ "length": 255,
+ "name": "vlan",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "the gateway for storage network",
+ "length": 255,
+ "name": "gateway",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "UUID of pod where the ip range belongs to",
+ "length": 255,
+ "name": "podid",
+ "related": "updatePod,createManagementNetworkIpRange",
+ "required": true,
+ "type": "uuid"
+ },
+ {
"description": "the netmask for storage network",
"length": 255,
"name": "netmask",
@@ -97150,28 +98747,6 @@
"type": "string"
},
{
- "description": "the gateway for storage network",
- "length": 255,
- "name": "gateway",
- "required": true,
- "type": "string"
- },
- {
- "description": "Optional. The vlan the ip range sits on, default to Null when it is not specificed which means you network is not on any Vlan. This is mainly for Vmware as other hypervisors can directly reterive bridge from pyhsical network traffic type table",
- "length": 255,
- "name": "vlan",
- "required": false,
- "type": "integer"
- },
- {
- "description": "UUID of pod where the ip range belongs to",
- "length": 255,
- "name": "podid",
- "related": "updatePod,createManagementNetworkIpRange",
- "required": true,
- "type": "uuid"
- },
- {
"description": "the ending IP address",
"length": 255,
"name": "endip",
@@ -97182,18 +98757,13 @@
"related": "",
"response": [
{
- "description": "the start ip of the storage network IP range",
- "name": "startip",
+ "description": "the uuid of storage network IP range.",
+ "name": "id",
"type": "string"
},
{
- "description": "the ID or VID of the VLAN.",
- "name": "vlan",
- "type": "integer"
- },
- {
- "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"
},
{
@@ -97207,37 +98777,42 @@
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "the end ip of the storage network IP range",
+ "name": "endip",
+ "type": "string"
},
{},
+ {},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the network uuid of storage network IP range",
+ "name": "networkid",
"type": "string"
},
{
+ "description": "the ID or VID of the VLAN.",
+ "name": "vlan",
+ "type": "integer"
+ },
+ {
"description": "the Pod uuid for the storage network IP range",
"name": "podid",
"type": "string"
},
{
- "description": "the netmask of the storage network IP range",
- "name": "netmask",
+ "description": "the current status of the latest async job acting 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 storage network IP range.",
- "name": "id",
+ "description": "the start ip of the storage network IP range",
+ "name": "startip",
"type": "string"
- },
- {
- "description": "the network uuid of storage network IP range",
- "name": "networkid",
- "type": "string"
- },
- {}
+ }
],
"since": "3.0.0"
},
@@ -97247,6 +98822,41 @@
"name": "listDomainChildren",
"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",
+ "length": 255,
+ "name": "listall",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "flag to display the resource icon for domains",
+ "length": 255,
+ "name": "showicon",
+ "required": false,
+ "type": "boolean"
+ },
+ {
"description": "list children domain by parent domain ID.",
"length": 255,
"name": "id",
@@ -97262,41 +98872,6 @@
"type": "boolean"
},
{
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
- },
- {
- "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false",
- "length": 255,
- "name": "listall",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "flag to display the resource icon for domains",
- "length": 255,
- "name": "showicon",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "",
- "length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
- },
- {
- "description": "",
- "length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
- },
- {
"description": "list children domains by name",
"length": 255,
"name": "name",
@@ -97306,140 +98881,20 @@
],
"related": "listDomains",
"response": [
- {},
- {
- "description": "the total number of cpu cores owned by domain",
- "name": "cputotal",
- "type": "long"
- },
- {
- "description": "the total number of projects available for administration by this domain",
- "name": "projectavailable",
- "type": "string"
- },
- {
- "description": "the date when this domain 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 volume which can be used by this domain",
- "name": "volumelimit",
- "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 number of public ip addresses allocated for this domain",
- "name": "iptotal",
- "type": "long"
- },
- {
- "description": "the network domain",
- "name": "networkdomain",
- "type": "string"
- },
- {
- "description": "the total number of vpcs available to be created for this domain",
- "name": "vpcavailable",
- "type": "string"
- },
- {
- "description": "the total number of vpcs the domain can own",
- "name": "vpclimit",
- "type": "string"
- },
- {
- "description": "the total volume available for this domain",
- "name": "volumeavailable",
- "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 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": "details for the domain",
- "name": "domaindetails",
- "type": "map"
- },
- {
- "description": "the total memory (in MB) the domain can own",
- "name": "memorylimit",
- "type": "string"
- },
- {
- "description": "the total number of templates available to be created by this domain",
- "name": "templateavailable",
- "type": "string"
- },
- {
- "description": "the level of the domain",
- "name": "level",
- "type": "integer"
- },
- {
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
- },
- {
- "description": "the total number of cpu cores available to be created for this domain",
- "name": "cpuavailable",
- "type": "string"
- },
- {
- "description": "the total volume being used by this domain",
- "name": "volumetotal",
- "type": "long"
- },
{
"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 number of virtual machines available for this domain to acquire",
- "name": "vmavailable",
- "type": "string"
- },
- {
- "description": "the total number of templates which have been created by this domain",
- "name": "templatetotal",
+ "description": "the total primary storage space (in GiB) owned by domain",
+ "name": "primarystoragetotal",
"type": "long"
},
{
- "description": "the total number of snapshots available for this domain",
- "name": "snapshotavailable",
+ "description": "the total number of public ip addresses available for this domain to acquire",
+ "name": "ipavailable",
"type": "string"
},
{
@@ -97448,24 +98903,9 @@
"type": "long"
},
{
- "description": "the total number of snapshots which can be stored by this domain",
- "name": "snapshotlimit",
- "type": "string"
- },
- {
- "description": "the total number of cpu cores the domain can own",
- "name": "cpulimit",
- "type": "string"
- },
- {
- "description": "the total number of networks owned by domain",
- "name": "networktotal",
- "type": "long"
- },
- {
- "description": "the total memory (in MB) owned by domain",
- "name": "memorytotal",
- "type": "long"
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
},
{
"description": "the domain ID of the parent domain",
@@ -97473,24 +98913,29 @@
"type": "string"
},
{
- "description": "the total number of templates which can be created by this domain",
- "name": "templatelimit",
+ "description": "the total number of vpcs the domain can own",
+ "name": "vpclimit",
"type": "string"
},
{
- "description": "the name of the domain",
- "name": "name",
+ "description": "the total number of networks available to be created for this domain",
+ "name": "networkavailable",
"type": "string"
},
{
- "description": "the total secondary storage space (in GiB) owned by domain",
- "name": "secondarystoragetotal",
- "type": "float"
+ "description": "the total secondary storage space (in GiB) available to be used for this domain",
+ "name": "secondarystorageavailable",
+ "type": "string"
},
{
- "description": "the total primary storage space (in GiB) the domain can own",
- "name": "primarystoragelimit",
- "type": "string"
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "description": "the date when this domain was created",
+ "name": "created",
+ "type": "date"
},
{
"description": "the total number of virtual machines deployed by this domain",
@@ -97498,44 +98943,23 @@
"type": "long"
},
{
- "description": "the total memory (in MB) available to be created for this domain",
- "name": "memoryavailable",
+ "description": "the total volume available for this domain",
+ "name": "volumeavailable",
"type": "string"
},
{
- "description": "the domain name of the parent domain",
- "name": "parentdomainname",
+ "description": "the total memory (in MB) the domain can own",
+ "name": "memorylimit",
"type": "string"
},
{
- "description": "the path of the domain",
- "name": "path",
- "type": "string"
- },
- {
- "description": "the total primary storage space (in GiB) owned by domain",
- "name": "primarystoragetotal",
+ "description": "the total number of projects being administrated by this domain",
+ "name": "projecttotal",
"type": "long"
},
{
- "description": "the total number of vpcs owned by domain",
- "name": "vpctotal",
- "type": "long"
- },
- {
- "description": "the total number of networks the domain can own",
- "name": "networklimit",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {},
- {
- "description": "the total secondary storage space (in GiB) available to be used for this domain",
- "name": "secondarystorageavailable",
+ "description": "the total secondary storage space (in GiB) the domain can own",
+ "name": "secondarystoragelimit",
"type": "string"
},
{
@@ -97544,13 +98968,49 @@
"type": "string"
},
{
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
+ "description": "the total primary storage space (in GiB) the domain can own",
+ "name": "primarystoragelimit",
+ "type": "string"
},
{
- "description": "the total number of networks available to be created for this domain",
- "name": "networkavailable",
+ "description": "the total number of templates available to be created by this domain",
+ "name": "templateavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of snapshots which can be stored by this domain",
+ "name": "snapshotlimit",
+ "type": "string"
+ },
+ {
+ "description": "details for the domain",
+ "name": "domaindetails",
+ "type": "map"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the total number of cpu cores the domain can own",
+ "name": "cpulimit",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the total number of templates which have been created by this domain",
+ "name": "templatetotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of vpcs owned by domain",
+ "name": "vpctotal",
+ "type": "long"
+ },
+ {
+ "description": "the domain name of the parent domain",
+ "name": "parentdomainname",
"type": "string"
},
{
@@ -97559,9 +99019,124 @@
"type": "string"
},
{
+ "description": "the total volume which can be used by this domain",
+ "name": "volumelimit",
+ "type": "string"
+ },
+ {
+ "description": "the total primary storage space (in GiB) available to be used for this domain",
+ "name": "primarystorageavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of cpu cores owned by domain",
+ "name": "cputotal",
+ "type": "long"
+ },
+ {
+ "description": "the name of the domain",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the path of the domain",
+ "name": "path",
+ "type": "string"
+ },
+ {
+ "description": "the total number of public ip addresses allocated for this domain",
+ "name": "iptotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of templates which can be created by this domain",
+ "name": "templatelimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of networks the domain can own",
+ "name": "networklimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of projects the domain can own",
+ "name": "projectlimit",
+ "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 level of the domain",
+ "name": "level",
+ "type": "integer"
+ },
+ {
+ "description": "the network domain",
+ "name": "networkdomain",
+ "type": "string"
+ },
+ {
+ "description": "the total number of cpu cores available to be created for this domain",
+ "name": "cpuavailable",
+ "type": "string"
+ },
+ {
"description": "the state of the domain",
"name": "state",
"type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the total number of vpcs available to be created for this domain",
+ "name": "vpcavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of projects available for administration by this domain",
+ "name": "projectavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total secondary storage space (in GiB) owned by domain",
+ "name": "secondarystoragetotal",
+ "type": "float"
+ },
+ {
+ "description": "the total volume being used by this domain",
+ "name": "volumetotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of networks owned by domain",
+ "name": "networktotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of snapshots available for this domain",
+ "name": "snapshotavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of public ip addresses this domain can acquire",
+ "name": "iplimit",
+ "type": "string"
+ },
+ {
+ "description": "the total memory (in MB) owned by domain",
+ "name": "memorytotal",
+ "type": "long"
}
]
},
@@ -97584,9 +99159,9 @@
{},
{},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
{
"description": "The base64 encoded encrypted password of the VM",
@@ -97594,9 +99169,9 @@
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
}
]
},
@@ -97606,11 +99181,12 @@
"name": "assignToGlobalLoadBalancerRule",
"params": [
{
- "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'",
+ "description": "the list load balancer rules that will be assigned to global load balancer rule",
"length": 255,
- "name": "gslblbruleweightsmap",
- "required": false,
- "type": "map"
+ "name": "loadbalancerrulelist",
+ "related": "",
+ "required": true,
+ "type": "list"
},
{
"description": "the ID of the global load balancer rule",
@@ -97621,36 +99197,35 @@
"type": "uuid"
},
{
- "description": "the list load balancer rules that will be assigned to global load balancer rule",
+ "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": "loadbalancerrulelist",
- "related": "",
- "required": true,
- "type": "list"
+ "name": "gslblbruleweightsmap",
+ "required": false,
+ "type": "map"
}
],
"response": [
{
- "description": "any text associated with the success or failure",
- "name": "displaytext",
- "type": "string"
- },
- {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
- {},
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
{
"description": "true if operation is executed successfully",
"name": "success",
"type": "boolean"
},
{},
+ {},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "any text associated with the success or failure",
+ "name": "displaytext",
+ "type": "string"
}
]
},
@@ -97660,31 +99235,27 @@
"name": "configureOvsElement",
"params": [
{
- "description": "Enabled/Disabled the service provider",
- "length": 255,
- "name": "enabled",
- "required": true,
- "type": "boolean"
- },
- {
"description": "the ID of the ovs provider",
"length": 255,
"name": "id",
"related": "configureOvsElement",
"required": true,
"type": "uuid"
+ },
+ {
+ "description": "Enabled/Disabled the service provider",
+ "length": 255,
+ "name": "enabled",
+ "required": true,
+ "type": "boolean"
}
],
"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 id of the ovs",
+ "name": "id",
"type": "string"
},
{
@@ -97693,14 +99264,19 @@
"type": "string"
},
{
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
"description": "the project name of the address",
"name": "project",
"type": "string"
},
{},
{
- "description": "the project id of the ipaddress",
- "name": "projectid",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
@@ -97709,25 +99285,24 @@
"type": "string"
},
{
- "description": "the domain ID associated with the provider",
- "name": "domainid",
- "type": "string"
- },
- {},
- {
- "description": "the id of the ovs",
- "name": "id",
- "type": "string"
- },
- {
"description": "Enabled/Disabled the service provider",
"name": "enabled",
"type": "boolean"
},
{
+ "description": "the domain ID associated with the provider",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
"description": "the account associated with the provider",
"name": "account",
"type": "string"
+ },
+ {
+ "description": "the project id of the ipaddress",
+ "name": "projectid",
+ "type": "string"
}
]
},
@@ -97737,23 +99312,9 @@
"name": "addImageStoreS3",
"params": [
{
- "description": "Use HTTPS instead of HTTP",
+ "description": "Name of the storage bucket",
"length": 255,
- "name": "usehttps",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "Connection timeout (milliseconds)",
- "length": 255,
- "name": "connectiontimeout",
- "required": false,
- "type": "integer"
- },
- {
- "description": "S3 access key",
- "length": 255,
- "name": "accesskey",
+ "name": "bucket",
"required": true,
"type": "string"
},
@@ -97765,13 +99326,6 @@
"type": "string"
},
{
- "description": "Name of the storage bucket",
- "length": 255,
- "name": "bucket",
- "required": true,
- "type": "string"
- },
- {
"description": "Connection TTL (milliseconds)",
"length": 255,
"name": "connectionttl",
@@ -97779,13 +99333,6 @@
"type": "integer"
},
{
- "description": "Socket timeout (milliseconds)",
- "length": 255,
- "name": "sockettimeout",
- "required": false,
- "type": "integer"
- },
- {
"description": "Whether TCP keep-alive is used",
"length": 255,
"name": "usetcpkeepalive",
@@ -97793,9 +99340,30 @@
"type": "boolean"
},
{
- "description": "Maximum number of times to retry on error",
+ "description": "S3 endpoint",
"length": 255,
- "name": "maxerrorretry",
+ "name": "endpoint",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "Connection timeout (milliseconds)",
+ "length": 255,
+ "name": "connectiontimeout",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "Use HTTPS instead of HTTP",
+ "length": 255,
+ "name": "usehttps",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "Socket timeout (milliseconds)",
+ "length": 255,
+ "name": "sockettimeout",
"required": false,
"type": "integer"
},
@@ -97807,16 +99375,28 @@
"type": "string"
},
{
- "description": "S3 endpoint",
+ "description": "S3 access key",
"length": 255,
- "name": "endpoint",
+ "name": "accesskey",
"required": true,
"type": "string"
+ },
+ {
+ "description": "Maximum number of times to retry on error",
+ "length": 255,
+ "name": "maxerrorretry",
+ "required": false,
+ "type": "integer"
}
],
"related": "listImageStores",
"response": [
{
+ "description": "the name of the image store",
+ "name": "name",
+ "type": "string"
+ },
+ {
"description": "the url of the image store",
"name": "url",
"type": "string"
@@ -97827,41 +99407,26 @@
"type": "string"
},
{
- "description": "the scope of the image store",
- "name": "scope",
- "type": "scopetype"
- },
- {},
- {
- "description": "the ID of the image store",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the name of the image store",
- "name": "name",
- "type": "string"
- },
- {},
- {
- "description": "the provider name of the image store",
- "name": "providername",
- "type": "string"
- },
- {
"description": "the protocol of the image store",
"name": "protocol",
"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 host's currently used disk size",
+ "name": "disksizeused",
+ "type": "long"
+ },
+ {
+ "description": "the provider name of the image store",
+ "name": "providername",
+ "type": "string"
},
{
"description": "defines if store is read-only",
@@ -97869,13 +99434,13 @@
"type": "boolean"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the ID of the image store",
+ "name": "id",
"type": "string"
},
{
- "description": "the host's currently used disk size",
- "name": "disksizeused",
+ "description": "the total disk size of the host",
+ "name": "disksizetotal",
"type": "long"
},
{
@@ -97884,9 +99449,19 @@
"type": "string"
},
{
- "description": "the total disk size of the host",
- "name": "disksizetotal",
- "type": "long"
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the 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"
}
],
"since": "4.7.0"
@@ -97897,21 +99472,13 @@
"name": "uploadTemplateDirectDownloadCertificate",
"params": [
{
- "description": "SSL certificate",
- "length": 65535,
- "name": "certificate",
+ "description": "Name for the uploaded certificate",
+ "length": 255,
+ "name": "name",
"required": true,
"type": "string"
},
{
- "description": "Zone to upload certificate",
- "length": 255,
- "name": "zoneid",
- "related": "listZones",
- "required": true,
- "type": "uuid"
- },
- {
"description": "Hypervisor type",
"length": 255,
"name": "hypervisor",
@@ -97919,22 +99486,41 @@
"type": "string"
},
{
- "description": "Name for the uploaded certificate",
- "length": 255,
- "name": "name",
- "required": true,
- "type": "string"
- },
- {
"description": "(optional) the host ID to revoke certificate",
"length": 255,
"name": "hostid",
"related": "reconnectHost,addBaremetalHost",
"required": false,
"type": "uuid"
+ },
+ {
+ "description": "Zone to upload certificate",
+ "length": 255,
+ "name": "zoneid",
+ "related": "listZones",
+ "required": true,
+ "type": "uuid"
+ },
+ {
+ "description": "SSL certificate",
+ "length": 65535,
+ "name": "certificate",
+ "required": true,
+ "type": "string"
}
],
"response": [
+ {
+ "description": "true if operation is executed successfully",
+ "name": "success",
+ "type": "boolean"
+ },
+ {},
+ {
+ "description": "any text associated with the success or failure",
+ "name": "displaytext",
+ "type": "string"
+ },
{},
{
"description": "the UUID of the latest async job acting on this object",
@@ -97945,17 +99531,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"
- },
- {},
- {
- "description": "true if operation is executed successfully",
- "name": "success",
- "type": "boolean"
}
],
"since": "4.11.0"
@@ -97966,11 +99541,27 @@
"name": "importUnmanagedInstance",
"params": [
{
- "description": "the host name of the instance",
+ "description": "the ID of the template for the virtual machine",
"length": 255,
- "name": "hostname",
+ "name": "templateid",
+ "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos",
"required": false,
- "type": "string"
+ "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": "import instance to the domain specified",
+ "length": 255,
+ "name": "domainid",
+ "related": "listDomains",
+ "required": false,
+ "type": "uuid"
},
{
"description": "datadisk template to disk-offering mapping using keys disk and diskOffering",
@@ -97980,10 +99571,32 @@
"type": "map"
},
{
- "description": "the ID of the template for the virtual machine",
+ "description": "the cluster ID",
"length": 255,
- "name": "templateid",
- "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos",
+ "name": "clusterid",
+ "related": "addCluster",
+ "required": true,
+ "type": "uuid"
+ },
+ {
+ "description": "VM is imported despite some of its NIC's MAC addresses are already present",
+ "length": 255,
+ "name": "forced",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "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",
"required": false,
"type": "uuid"
},
@@ -97996,21 +99609,6 @@
"type": "uuid"
},
{
- "description": "import instance to the domain specified",
- "length": 255,
- "name": "domainid",
- "related": "listDomains",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "used to specify the custom parameters.",
- "length": 255,
- "name": "details",
- "required": false,
- "type": "map"
- },
- {
"description": "an optional account for the virtual machine. Must be used with domainId.",
"length": 255,
"name": "account",
@@ -98018,18 +99616,11 @@
"type": "string"
},
{
- "description": "VM is imported despite some of its NIC's MAC addresses are already present",
+ "description": "the host name of the instance",
"length": 255,
- "name": "forced",
+ "name": "hostname",
"required": false,
- "type": "boolean"
- },
- {
- "description": "VM nic to ip address mapping using keys nic, ip4Address",
- "length": 255,
- "name": "nicipaddresslist",
- "required": false,
- "type": "map"
+ "type": "string"
},
{
"description": "the hypervisor name of the instance",
@@ -98046,144 +99637,40 @@
"type": "map"
},
{
- "description": "the cluster ID",
+ "description": "VM nic to ip address mapping using keys nic, ip4Address",
"length": 255,
- "name": "clusterid",
- "related": "addCluster",
- "required": true,
- "type": "uuid"
+ "name": "nicipaddresslist",
+ "required": false,
+ "type": "map"
},
{
- "description": "the display name of the instance",
+ "description": "used to specify the custom parameters.",
"length": 255,
- "name": "displayname",
+ "name": "details",
"required": false,
- "type": "string"
- },
- {
- "description": "vm and its volumes are allowed to migrate to different host/pool when offerings passed are incompatible with current host/pool",
- "length": 255,
- "name": "migrateallowed",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "import instance for the project",
- "length": 255,
- "name": "projectid",
- "related": "activateProject",
- "required": false,
- "type": "uuid"
+ "type": "map"
}
],
"related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,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 domain in which the virtual machine exists",
- "name": "domain",
+ "description": "the name of the disk offering of the virtual machine",
+ "name": "diskofferingname",
"type": "string"
},
{
- "description": "OS name of the vm",
- "name": "osdisplayname",
- "type": "string"
- },
- {
- "description": "the name of the virtual machine",
- "name": "name",
- "type": "string"
- },
- {},
- {
- "description": "the group name of the virtual machine",
- "name": "group",
- "type": "string"
- },
- {
- "description": "the name of the availability zone for the virtual machine",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "list of affinity groups associated with the virtual machine",
- "name": "affinitygroup",
- "response": [
- {
- "description": "the account owning the affinity group",
- "name": "account",
- "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 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 description of the affinity group",
- "name": "description",
- "type": "string"
- },
- {
- "description": "the type of the affinity group",
- "name": "type",
- "type": "string"
- },
- {
- "description": "virtual machine IDs associated with this affinity group",
- "name": "virtualmachineIds",
- "type": "list"
- },
- {
- "description": "the project name of the affinity group",
- "name": "project",
- "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"
- },
- {
- "description": "the incoming network traffic on the vm",
- "name": "networkkbsread",
+ "description": "the write (io) of disk on the vm",
+ "name": "diskiowrite",
"type": "long"
},
{
- "description": "public IP address id associated with vm via Static nat rule",
- "name": "publicip",
+ "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 target memory in vm",
+ "name": "memorytargetkbs",
"type": "long"
},
{
@@ -98192,28 +99679,18 @@
"type": "string"
},
{
- "description": "the name of the ISO attached to the virtual machine",
- "name": "isoname",
+ "description": "the ID of the host for the virtual machine",
+ "name": "hostid",
"type": "string"
},
{
- "description": "the date when this virtual machine was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "device type of the root volume",
- "name": "rootdevicetype",
+ "description": "State of the Service from LB rule",
+ "name": "servicestate",
"type": "string"
},
{
- "description": "the name of the service offering of the virtual machine",
- "name": "serviceofferingname",
- "type": "string"
- },
- {
- "description": "OS type id of the vm",
- "name": "ostypeid",
+ "description": "the state of the virtual machine",
+ "name": "state",
"type": "string"
},
{
@@ -98222,64 +99699,13 @@
"type": "string"
},
{
- "description": "the outgoing network traffic on the host",
- "name": "networkkbswrite",
- "type": "long"
- },
- {
- "description": "the virtual network for the service offering",
- "name": "forvirtualnetwork",
- "type": "boolean"
- },
- {
- "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.",
- "name": "isdynamicallyscalable",
- "type": "boolean"
- },
- {
"description": "user generated name. The name of the virtual machine is returned if no displayname exists.",
"name": "displayname",
"type": "string"
},
{
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "an optional field whether to the display the vm to the end user or not.",
- "name": "displayvm",
- "type": "boolean"
- },
- {
- "description": "the name of the backup offering of the virtual machine",
- "name": "backupofferingname",
- "type": "string"
- },
- {},
- {
- "description": "the ID of the availablility zone for the virtual machine",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the user's ID who deployed the virtual machine",
- "name": "userid",
- "type": "string"
- },
- {
- "description": "the ID of the ISO attached to the virtual machine",
- "name": "isoid",
- "type": "string"
- },
- {
- "description": "Vm details in key/value pairs.",
- "name": "details",
- "type": "map"
- },
- {
- "description": "the password (if exists) of the virtual machine",
- "name": "password",
+ "description": "ssh key-pair",
+ "name": "keypair",
"type": "string"
},
{
@@ -98288,87 +99714,37 @@
"type": "string"
},
{
- "description": "the name of the template for the virtual machine",
- "name": "templatename",
+ "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.",
+ "name": "isdynamicallyscalable",
+ "type": "boolean"
+ },
+ {
+ "description": "the read (bytes) of disk on the vm",
+ "name": "diskkbsread",
+ "type": "long"
+ },
+ {
+ "description": "the project id of the vm",
+ "name": "projectid",
"type": "string"
},
{
- "description": "the ID of the disk offering of the virtual machine",
- "name": "diskofferingid",
+ "description": "the hypervisor on which the template runs",
+ "name": "hypervisor",
"type": "string"
},
{
- "description": "the ID of the host for the virtual machine",
- "name": "hostid",
- "type": "string"
- },
- {
- "description": "the account associated with the virtual machine",
- "name": "account",
- "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": "the list of nics associated with vm",
"name": "nic",
"response": [
{
- "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",
- "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": "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": "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 IPv6 address of network",
- "name": "ip6address",
+ "description": "the gateway of IPv6 network",
+ "name": "ip6gateway",
"type": "string"
},
{
@@ -98377,21 +99753,36 @@
"type": "string"
},
{
- "description": "the netmask of the nic",
- "name": "netmask",
- "type": "string"
- },
- {
- "description": "the ID of the corresponding network",
- "name": "networkid",
- "type": "string"
- },
- {
"description": "the broadcast uri of the nic",
"name": "broadcasturi",
"type": "string"
},
{
+ "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise",
+ "name": "nsxlogicalswitchport",
+ "type": "string"
+ },
+ {
+ "description": "the isolated private VLAN type if available",
+ "name": "isolatedpvlantype",
+ "type": "string"
+ },
+ {
+ "description": "IP addresses associated with NIC found for unmanaged VM",
+ "name": "ipaddresses",
+ "type": "list"
+ },
+ {
+ "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"
@@ -98402,38 +99793,18 @@
"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 extra dhcp options on the nic",
- "name": "extradhcpoption",
- "type": "list"
- },
- {
- "description": "the gateway of IPv6 network",
- "name": "ip6gateway",
+ "description": "the isolation uri of the nic",
+ "name": "isolationuri",
"type": "string"
},
{
- "description": "the cidr of IPv6 network",
- "name": "ip6cidr",
- "type": "string"
- },
- {
- "description": "true if nic is default, false otherwise",
- "name": "macaddress",
- "type": "string"
- },
- {
- "description": "the isolated private VLAN type if available",
- "name": "isolatedpvlantype",
+ "description": "Type of adapter if available",
+ "name": "adaptertype",
"type": "string"
},
{
@@ -98442,22 +99813,77 @@
"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": "true if nic is default, false otherwise",
+ "name": "macaddress",
+ "type": "string"
+ },
+ {
"description": "the ID of the nic",
"name": "id",
"type": "string"
+ },
+ {
+ "description": "the ID of the corresponding network",
+ "name": "networkid",
+ "type": "string"
+ },
+ {
+ "description": "the gateway of the nic",
+ "name": "gateway",
+ "type": "string"
+ },
+ {
+ "description": "the ip address of the nic",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "the cidr of IPv6 network",
+ "name": "ip6cidr",
+ "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 netmask of the nic",
+ "name": "netmask",
+ "type": "string"
+ },
+ {
+ "description": "true if nic is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
}
],
"type": "set"
},
{
- "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 read (bytes) of disk on the vm",
- "name": "diskkbsread",
- "type": "long"
+ "description": "the name of the ISO attached to the virtual machine",
+ "name": "isoname",
+ "type": "string"
},
{
"description": "the amount of the vm's CPU currently used",
@@ -98465,44 +99891,50 @@
"type": "string"
},
{
- "description": "the hypervisor on which the template runs",
- "name": "hypervisor",
- "type": "string"
- },
- {
- "description": "the ID of the domain in which the virtual machine exists",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "instance name of the user vm; this parameter is returned to the ROOT admin only",
- "name": "instancename",
- "type": "string"
- },
- {
- "description": "the 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 password (if exists) of the virtual machine",
+ "name": "password",
+ "type": "string"
+ },
+ {
+ "description": "the group ID of the virtual machine",
+ "name": "groupid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "description": " an alternate display text of the template for the virtual machine",
+ "name": "templatedisplaytext",
+ "type": "string"
+ },
+ {
"description": "the user's name who deployed the virtual machine",
"name": "username",
"type": "string"
},
{
- "description": "true if the password rest feature is enabled, false otherwise",
- "name": "passwordenabled",
- "type": "boolean"
+ "description": "the incoming network traffic on the vm",
+ "name": "networkkbsread",
+ "type": "long"
},
{
- "description": "the memory allocated for the virtual machine",
- "name": "memory",
- "type": "integer"
+ "description": "public IP address id associated with vm via Static nat rule",
+ "name": "publicipid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the host for the virtual machine",
+ "name": "hostname",
+ "type": "string"
},
{
"description": "the number of cpu this virtual machine is running with",
@@ -98510,23 +99942,79 @@
"type": "integer"
},
{
- "description": "the target memory in vm",
- "name": "memorytargetkbs",
+ "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 total number of network traffic bytes received",
+ "name": "receivedbytes",
"type": "long"
},
{
+ "description": "the speed of each cpu",
+ "name": "cpuspeed",
+ "type": "integer"
+ },
+ {
+ "description": "Guest vm Boot Type",
+ "name": "boottype",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "device type of the root volume",
+ "name": "rootdevicetype",
+ "type": "string"
+ },
+ {
+ "description": "true if high-availability is enabled, false otherwise",
+ "name": "haenable",
+ "type": "boolean"
+ },
+ {
+ "description": "the ID of the domain in which the virtual machine exists",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the vgpu type used by the virtual machine",
+ "name": "vgpu",
+ "type": "string"
+ },
+ {
+ "description": "the name of the availability zone for the virtual machine",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
"description": "list of security groups associated with the virtual machine",
"name": "securitygroup",
"response": [
{
- "description": "the domain name of the security group",
- "name": "domain",
+ "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 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 domain ID of the security group",
@@ -98534,17 +100022,32 @@
"type": "string"
},
{
+ "description": "the project id of the group",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the group",
+ "name": "project",
+ "type": "string"
+ },
+ {
"description": "the list of resource tags associated with the rule",
"name": "tags",
"response": [
{
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
"description": "tag value",
"name": "value",
"type": "string"
},
{
- "description": "resource type",
- "name": "resourcetype",
+ "description": "tag key name",
+ "name": "key",
"type": "string"
},
{
@@ -98558,8 +100061,8 @@
"type": "string"
},
{
- "description": "tag key name",
- "name": "key",
+ "description": "resource type",
+ "name": "resourcetype",
"type": "string"
},
{
@@ -98568,11 +100071,6 @@
"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"
@@ -98591,14 +100089,118 @@
"type": "set"
},
{
- "description": "the project id of the group",
- "name": "projectid",
- "type": "string"
+ "description": "the list of ingress rules associated with the security group",
+ "name": "ingressrule",
+ "response": [
+ {
+ "description": "account owning the security group rule",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the type of the ICMP message response",
+ "name": "icmptype",
+ "type": "integer"
+ },
+ {
+ "description": "the list of resource tags associated with the rule",
+ "name": "tags",
+ "response": [
+ {
+ "description": "tag 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 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": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the ending IP of the security group rule ",
+ "name": "endport",
+ "type": "integer"
+ },
+ {
+ "description": "the code for the ICMP message response",
+ "name": "icmpcode",
+ "type": "integer"
+ },
+ {
+ "description": "the starting IP of the security group rule",
+ "name": "startport",
+ "type": "integer"
+ },
+ {
+ "description": "the CIDR notation for the base IP address of the security group rule",
+ "name": "cidr",
+ "type": "string"
+ },
+ {
+ "description": "the id of the security group rule",
+ "name": "ruleid",
+ "type": "string"
+ },
+ {
+ "description": "security group name",
+ "name": "securitygroupname",
+ "type": "string"
+ },
+ {
+ "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 list of virtualmachine ids associated with this securitygroup",
+ "name": "virtualmachineids",
+ "type": "set"
},
{
"description": "the account owning the security group",
@@ -98606,294 +100208,150 @@
"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": "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": "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": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "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 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 id of the security group rule",
+ "name": "ruleid",
+ "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"
+ }
+ ],
+ "type": "set"
+ },
+ {
"description": "the ID of the security group",
"name": "id",
"type": "string"
},
{
- "description": "the list of ingress rules associated with the security group",
- "name": "ingressrule",
- "response": [
- {
- "description": "the id of the security group rule",
- "name": "ruleid",
- "type": "string"
- },
- {
- "description": "the CIDR notation for the base IP address of the security group rule",
- "name": "cidr",
- "type": "string"
- },
- {
- "description": "the list of resource tags associated with the rule",
- "name": "tags",
- "response": [
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "security group name",
- "name": "securitygroupname",
- "type": "string"
- },
- {
- "description": "account owning the security group rule",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the type of the ICMP message response",
- "name": "icmptype",
- "type": "integer"
- },
- {
- "description": "the code for the ICMP message response",
- "name": "icmpcode",
- "type": "integer"
- },
- {
- "description": "the ending IP of the security group rule ",
- "name": "endport",
- "type": "integer"
- },
- {
- "description": "the starting IP of the security group rule",
- "name": "startport",
- "type": "integer"
- },
- {
- "description": "the protocol of the security group rule",
- "name": "protocol",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the project name of the group",
- "name": "project",
+ "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 code for the ICMP message response",
- "name": "icmpcode",
- "type": "integer"
- },
- {
- "description": "the list of resource tags associated with the rule",
- "name": "tags",
- "response": [
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the CIDR notation for the base IP address of the security group rule",
- "name": "cidr",
- "type": "string"
- },
- {
- "description": "the protocol of the security group rule",
- "name": "protocol",
- "type": "string"
- },
- {
- "description": "the id of the security group rule",
- "name": "ruleid",
- "type": "string"
- },
- {
- "description": "the ending IP of the security group rule ",
- "name": "endport",
- "type": "integer"
- },
- {
- "description": "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 starting IP of the security group rule",
- "name": "startport",
- "type": "integer"
- }
- ],
- "type": "set"
- },
- {
- "description": "the name of the security group",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the number of virtualmachines associated with this securitygroup",
- "name": "virtualmachinecount",
- "type": "integer"
}
],
"type": "set"
},
{
- "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.",
- "name": "templateid",
- "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 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": "ssh key-pair",
- "name": "keypair",
+ "description": "the ID of the availablility zone for the virtual machine",
+ "name": "zoneid",
"type": "string"
},
{
- "description": "the vgpu type used by the virtual machine",
- "name": "vgpu",
- "type": "string"
- },
- {
- "description": "the internal memory that's free in vm or zero if it can not be calculated",
- "name": "memoryintfreekbs",
+ "description": "the total number of network traffic bytes sent",
+ "name": "sentbytes",
"type": "long"
},
{
- "description": "the ID of the backup offering of the virtual machine",
- "name": "backupofferingid",
- "type": "string"
+ "description": "the read (io) of disk on the vm",
+ "name": "diskioread",
+ "type": "long"
},
{
- "description": "the project id of the vm",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the name of the disk offering of the virtual machine",
- "name": "diskofferingname",
+ "description": "the group name of the virtual machine",
+ "name": "group",
"type": "string"
},
{
@@ -98902,6 +100360,26 @@
"type": "string"
},
{
+ "description": "Os type ID of the virtual machine",
+ "name": "guestosid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the virtual machine",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the name of the service offering of the virtual machine",
+ "name": "serviceofferingname",
+ "type": "string"
+ },
+ {
+ "description": "the memory used by the vm",
+ "name": "memorykbs",
+ "type": "long"
+ },
+ {
"description": "the list of resource tags associated",
"name": "tags",
"response": [
@@ -98911,38 +100389,8 @@
"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": "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": "customer associated with the tag",
- "name": "customer",
+ "description": "tag key name",
+ "name": "key",
"type": "string"
},
{
@@ -98951,36 +100399,132 @@
"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",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
"type": "string"
}
],
"type": "set"
},
{
+ "description": "OS name of the vm",
+ "name": "osdisplayname",
+ "type": "string"
+ },
+ {
+ "description": "the outgoing network traffic on the host",
+ "name": "networkkbswrite",
+ "type": "long"
+ },
+ {
+ "description": "the name of the domain in which the virtual machine exists",
+ "name": "domain",
+ "type": "string"
+ },
+ {
"description": "the project name of the vm",
"name": "project",
"type": "string"
},
{
- "description": "the total number of network traffic bytes received",
- "name": "receivedbytes",
+ "description": "the write (bytes) of disk on the vm",
+ "name": "diskkbswrite",
"type": "long"
},
{
- "description": "the total number of network traffic bytes sent",
- "name": "sentbytes",
+ "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 virtual network for the service offering",
+ "name": "forvirtualnetwork",
+ "type": "boolean"
+ },
+ {
+ "description": "the ID of the ISO attached to the virtual machine",
+ "name": "isoid",
+ "type": "string"
+ },
+ {
+ "description": "public IP address id associated with vm via Static nat rule",
+ "name": "publicip",
+ "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 template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.",
+ "name": "templateid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the internal memory that's free in vm or zero if it can not be calculated",
+ "name": "memoryintfreekbs",
"type": "long"
},
{
- "description": "the write (io) of disk on the vm",
- "name": "diskiowrite",
- "type": "long"
+ "description": "the ID of the virtual machine",
+ "name": "id",
+ "type": "string"
},
{
- "description": " an alternate display text of the template for the virtual machine",
- "name": "templatedisplaytext",
+ "description": "the ID of the service offering of the virtual machine",
+ "name": "serviceofferingid",
+ "type": "string"
+ },
+ {
+ "description": "OS type id of the vm",
+ "name": "ostypeid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the template for the virtual machine",
+ "name": "templatename",
"type": "string"
},
{
@@ -98989,45 +100533,76 @@
"type": "long"
},
{
- "description": "the write (bytes) of disk on the vm",
- "name": "diskkbswrite",
- "type": "long"
+ "description": "the ID of the disk offering of the virtual machine",
+ "name": "diskofferingid",
+ "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 speed of each cpu",
- "name": "cpuspeed",
- "type": "integer"
- },
- {
- "description": "an alternate display text of the ISO attached to the virtual machine",
- "name": "isodisplaytext",
- "type": "string"
- },
- {},
- {
- "description": "the memory used by the vm",
- "name": "memorykbs",
- "type": "long"
- },
- {
- "description": "the ID of the service offering of the virtual machine",
- "name": "serviceofferingid",
+ "description": "the account associated with the virtual machine",
+ "name": "account",
"type": "string"
},
{
- "description": "Os type ID of the virtual machine",
- "name": "guestosid",
- "type": "string"
- },
- {
- "description": "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 account owning the affinity group",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the description of the affinity group",
+ "name": "description",
+ "type": "string"
+ },
+ {
+ "description": "the name of the affinity group",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the affinity group",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the affinity group",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID of the affinity group",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the 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"
+ },
+ {
+ "description": "virtual machine IDs associated with this affinity group",
+ "name": "virtualmachineIds",
+ "type": "list"
+ }
+ ],
+ "type": "set"
}
],
"since": "4.14.0"
@@ -99038,6 +100613,13 @@
"name": "createPhysicalNetwork",
"params": [
{
+ "description": "the VLAN for the physical network",
+ "length": 255,
+ "name": "vlan",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "the Zone ID for the physical network",
"length": 255,
"name": "zoneid",
@@ -99046,6 +100628,20 @@
"type": "uuid"
},
{
+ "description": "the isolation method for the physical network[VLAN/L3/GRE]",
+ "length": 255,
+ "name": "isolationmethods",
+ "required": false,
+ "type": "list"
+ },
+ {
+ "description": "the speed for the physical network[1G/10G]",
+ "length": 255,
+ "name": "networkspeed",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "domain ID of the account owning a physical network",
"length": 255,
"name": "domainid",
@@ -99061,20 +100657,6 @@
"type": "string"
},
{
- "description": "the VLAN for the physical network",
- "length": 255,
- "name": "vlan",
- "required": false,
- "type": "string"
- },
- {
- "description": "the speed for the physical network[1G/10G]",
- "length": 255,
- "name": "networkspeed",
- "required": false,
- "type": "string"
- },
- {
"description": "Tag the physical network",
"length": 255,
"name": "tags",
@@ -99082,13 +100664,6 @@
"type": "list"
},
{
- "description": "the isolation method for the physical network[VLAN/L3/GRE]",
- "length": 255,
- "name": "isolationmethods",
- "required": false,
- "type": "list"
- },
- {
"description": "the name of the physical network",
"length": 255,
"name": "name",
@@ -99099,18 +100674,13 @@
"related": "",
"response": [
{
- "description": "zone name of the physical network",
- "name": "zonename",
+ "description": "zone id of the physical network",
+ "name": "zoneid",
"type": "string"
},
{
- "description": "state of the physical network",
- "name": "state",
- "type": "string"
- },
- {
- "description": "Broadcast domain range of the physical network",
- "name": "broadcastdomainrange",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
@@ -99119,6 +100689,17 @@
"type": "string"
},
{
+ "description": "zone name of the physical network",
+ "name": "zonename",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "Broadcast domain range of the physical network",
+ "name": "broadcastdomainrange",
+ "type": "string"
+ },
+ {
"description": "the speed of the physical network",
"name": "networkspeed",
"type": "string"
@@ -99129,40 +100710,34 @@
"type": "integer"
},
{
- "description": "name of the physical network",
- "name": "name",
- "type": "string"
- },
- {
"description": "comma separated tag",
"name": "tags",
"type": "string"
},
+ {
+ "description": "the uuid of the physical network",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "state of the physical network",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "name of the physical network",
+ "name": "name",
+ "type": "string"
+ },
{},
{
- "description": "zone id of the physical network",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the domain id of the physical network owner",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
"description": "isolation methods",
"name": "isolationmethods",
"type": "string"
},
- {},
{
- "description": "the uuid of the physical network",
- "name": "id",
+ "description": "the domain id of the physical network owner",
+ "name": "domainid",
"type": "string"
}
],
@@ -99174,17 +100749,47 @@
"name": "listAutoScaleVmGroups",
"params": [
{
- "description": "list only resources belonging to the domain specified",
+ "description": "the availability zone ID",
"length": 255,
- "name": "domainid",
- "related": "listDomains",
+ "name": "zoneid",
+ "related": "listZones",
"required": false,
"type": "uuid"
},
{
- "description": "the ID of the policy",
+ "description": "",
"length": 255,
- "name": "policyid",
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter",
+ "length": 255,
+ "name": "fordisplay",
+ "required": false,
+ "since": "4.4",
+ "type": "boolean"
+ },
+ {
+ "description": "the ID of the profile",
+ "length": 255,
+ "name": "vmprofileid",
+ "related": "createAutoScaleVmProfile",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
+ "length": 255,
+ "name": "isrecursive",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "the ID of the loadbalancer",
+ "length": 255,
+ "name": "lbruleid",
"related": "",
"required": false,
"type": "uuid"
@@ -99197,33 +100802,9 @@
"type": "boolean"
},
{
- "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"
- },
- {
- "description": "the availability zone ID",
- "length": 255,
- "name": "zoneid",
- "related": "listZones",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "the ID of the profile",
- "length": 255,
- "name": "vmprofileid",
- "related": "createAutoScaleVmProfile",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
+ "name": "account",
"required": false,
"type": "string"
},
@@ -99235,28 +100816,13 @@
"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": "the ID of the autoscale vm group",
- "length": 255,
- "name": "id",
- "related": "listAutoScaleVmGroups",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "",
- "length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
- },
- {
"description": "list objects by project",
"length": 255,
"name": "projectid",
@@ -99265,36 +100831,67 @@
"type": "uuid"
},
{
- "description": "the ID of the loadbalancer",
+ "description": "the ID of the policy",
"length": 255,
- "name": "lbruleid",
+ "name": "policyid",
"related": "",
"required": false,
"type": "uuid"
},
{
- "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
+ "description": "the ID of the autoscale vm group",
"length": 255,
- "name": "isrecursive",
+ "name": "id",
+ "related": "listAutoScaleVmGroups",
"required": false,
- "type": "boolean"
+ "type": "uuid"
+ },
+ {
+ "description": "list only resources belonging to the domain specified",
+ "length": 255,
+ "name": "domainid",
+ "related": "listDomains",
+ "required": false,
+ "type": "uuid"
}
],
"related": "",
"response": [
{
+ "description": "the domain name of the vm profile",
+ "name": "domain",
+ "type": "string"
+ },
+ {},
+ {},
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "is group for display to the regular user",
+ "name": "fordisplay",
+ "type": "boolean"
+ },
+ {
"description": "the domain ID of the vm profile",
"name": "domainid",
"type": "string"
},
{
- "description": "the domain name of the vm profile",
- "name": "domain",
- "type": "string"
+ "description": "list of scaleup autoscale policies",
+ "name": "scaleuppolicies",
+ "type": "list"
},
{
- "description": "the load balancer rule ID",
- "name": "lbruleid",
+ "description": "the frequency at which the conditions have to be evaluated",
+ "name": "interval",
+ "type": "int"
+ },
+ {
+ "description": "the autoscale profile that contains information about the vms in the vm group.",
+ "name": "vmprofileid",
"type": "string"
},
{
@@ -99303,9 +100900,19 @@
"type": "list"
},
{
- "description": "is group for display to the regular user",
- "name": "fordisplay",
- "type": "boolean"
+ "description": "the project name of the vm profile",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the autoscale vm group ID",
+ "name": "id",
+ "type": "string"
},
{
"description": "the current state of the AutoScale Vm Group",
@@ -99313,18 +100920,8 @@
"type": "string"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the account owning the instance group",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the autoscale profile that contains information about the vms in the vm group.",
- "name": "vmprofileid",
+ "description": "the load balancer rule ID",
+ "name": "lbruleid",
"type": "string"
},
{
@@ -99333,16 +100930,10 @@
"type": "int"
},
{
- "description": "the autoscale vm group ID",
- "name": "id",
+ "description": "the account owning the instance group",
+ "name": "account",
"type": "string"
},
- {},
- {
- "description": "list of scaleup autoscale policies",
- "name": "scaleuppolicies",
- "type": "list"
- },
{
"description": "the project id vm profile",
"name": "projectid",
@@ -99352,22 +100943,6 @@
"description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.",
"name": "maxmembers",
"type": "int"
- },
- {},
- {
- "description": "the project name of the vm profile",
- "name": "project",
- "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"
}
]
},
@@ -99377,13 +100952,6 @@
"name": "createFirewallRule",
"params": [
{
- "description": "the CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,).",
- "length": 255,
- "name": "cidrlist",
- "required": false,
- "type": "list"
- },
- {
"description": "type of firewallrule: system/user",
"length": 255,
"name": "type",
@@ -99391,20 +100959,6 @@
"type": "string"
},
{
- "description": "type of the ICMP message being sent",
- "length": 255,
- "name": "icmptype",
- "required": false,
- "type": "integer"
- },
- {
- "description": "the ending port of firewall rule",
- "length": 255,
- "name": "endport",
- "required": false,
- "type": "integer"
- },
- {
"description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.",
"length": 255,
"name": "protocol",
@@ -99412,21 +100966,6 @@
"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 starting port of firewall rule",
- "length": 255,
- "name": "startport",
- "required": false,
- "type": "integer"
- },
- {
"description": "the IP address id of the port forwarding rule",
"length": 255,
"name": "ipaddressid",
@@ -99435,11 +100974,47 @@
"type": "uuid"
},
{
+ "description": "the ending port of firewall rule",
+ "length": 255,
+ "name": "endport",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "the starting port of firewall rule",
+ "length": 255,
+ "name": "startport",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "an optional field, whether to the display the rule to the end user or not",
+ "length": 255,
+ "name": "fordisplay",
+ "required": false,
+ "since": "4.4",
+ "type": "boolean"
+ },
+ {
+ "description": "type of the ICMP message being sent",
+ "length": 255,
+ "name": "icmptype",
+ "required": false,
+ "type": "integer"
+ },
+ {
"description": "error code for this icmp message",
"length": 255,
"name": "icmpcode",
"required": false,
"type": "integer"
+ },
+ {
+ "description": "the CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,).",
+ "length": 255,
+ "name": "cidrlist",
+ "required": false,
+ "type": "list"
}
],
"related": "updateEgressFirewallRule",
@@ -99451,19 +101026,25 @@
},
{},
{
- "description": "the protocol of the firewall rule",
- "name": "protocol",
+ "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 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 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 ID of the firewall rule",
@@ -99471,40 +101052,20 @@
"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 network id of the firewall rule",
- "name": "networkid",
- "type": "string"
- },
- {
- "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).",
- "name": "cidrlist",
- "type": "string"
- },
- {
"description": "the 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": "the domain associated with the tag",
"name": "domain",
"type": "string"
},
{
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
"description": "the project name where tag belongs to",
"name": "project",
"type": "string"
@@ -99515,13 +101076,13 @@
"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"
},
{
@@ -99530,39 +101091,28 @@
"type": "string"
},
{
- "description": "tag value",
- "name": "value",
+ "description": "resource type",
+ "name": "resourcetype",
"type": "string"
},
{
- "description": "id of the resource",
- "name": "resourceid",
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
"type": "string"
}
],
"type": "list"
},
{
- "description": "the public ip address for the firewall rule",
- "name": "ipaddress",
+ "description": "the network id of the firewall rule",
+ "name": "networkid",
"type": "string"
},
- {},
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the public ip address id for the firewall rule",
- "name": "ipaddressid",
- "type": "string"
- },
- {
- "description": "is rule for display to the regular user",
- "name": "fordisplay",
- "type": "boolean"
- },
{
"description": "error code for this icmp message",
"name": "icmpcode",
@@ -99574,9 +101124,34 @@
"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 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": "is rule for display to the regular user",
+ "name": "fordisplay",
+ "type": "boolean"
+ },
+ {
+ "description": "the public ip address for the firewall rule",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
}
]
},
@@ -99586,59 +101161,6 @@
"name": "createVolume",
"params": [
{
- "description": "the project associated with the volume. Mutually exclusive with account parameter",
- "length": 255,
- "name": "projectid",
- "related": "activateProject",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "the ID of the disk offering. Either diskOfferingId or snapshotId must be passed in.",
- "length": 255,
- "name": "diskofferingid",
- "related": "",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "min iops",
- "length": 255,
- "name": "miniops",
- "required": false,
- "type": "long"
- },
- {
- "description": "max iops",
- "length": 255,
- "name": "maxiops",
- "required": false,
- "type": "long"
- },
- {
- "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only",
- "length": 255,
- "name": "customid",
- "required": false,
- "type": "string"
- },
- {
- "description": "the ID of the availability zone",
- "length": 255,
- "name": "zoneid",
- "related": "listZones",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "the snapshot ID for the disk volume. Either diskOfferingId or snapshotId must be passed in.",
- "length": 255,
- "name": "snapshotid",
- "related": "",
- "required": false,
- "type": "uuid"
- },
- {
"description": "the ID of the virtual machine; to be used with snapshot Id, VM to which the volume gets attached after creation",
"length": 255,
"name": "virtualmachineid",
@@ -99654,6 +101176,58 @@
"type": "string"
},
{
+ "description": "the snapshot ID for the disk volume. Either diskOfferingId or snapshotId must be passed in.",
+ "length": 255,
+ "name": "snapshotid",
+ "related": "",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "the ID of the availability zone",
+ "length": 255,
+ "name": "zoneid",
+ "related": "listZones",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "max iops",
+ "length": 255,
+ "name": "maxiops",
+ "required": false,
+ "type": "long"
+ },
+ {
+ "description": "an optional field, whether to display the volume to the end user or not.",
+ "length": 255,
+ "name": "displayvolume",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "the ID of the disk offering. Either diskOfferingId or snapshotId must be passed in.",
+ "length": 255,
+ "name": "diskofferingid",
+ "related": "",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "Arbitrary volume size",
+ "length": 255,
+ "name": "size",
+ "required": false,
+ "type": "long"
+ },
+ {
+ "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only",
+ "length": 255,
+ "name": "customid",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "the name of the disk volume",
"length": 255,
"name": "name",
@@ -99661,6 +101235,13 @@
"type": "string"
},
{
+ "description": "min iops",
+ "length": 255,
+ "name": "miniops",
+ "required": false,
+ "type": "long"
+ },
+ {
"description": "the domain ID associated with the disk offering. If used with the account parameter returns the disk volume associated with the account for the specified domain.",
"length": 255,
"name": "domainid",
@@ -99669,207 +101250,69 @@
"type": "uuid"
},
{
- "description": "an optional field, whether to display the volume to the end user or not.",
+ "description": "the project associated with the volume. Mutually exclusive with account parameter",
"length": 255,
- "name": "displayvolume",
+ "name": "projectid",
+ "related": "activateProject",
"required": false,
- "type": "boolean"
- },
- {
- "description": "Arbitrary volume size",
- "length": 255,
- "name": "size",
- "required": false,
- "type": "long"
+ "type": "uuid"
}
],
"related": "attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume",
"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 template for the virtual machine",
- "name": "templatedisplaytext",
+ "description": "name of the service offering for root disk",
+ "name": "serviceofferingname",
"type": "string"
},
{
- "description": "the domain associated with the disk volume",
- "name": "domain",
+ "description": "pod name of the volume",
+ "name": "podname",
"type": "string"
},
{
- "description": "state of the virtual machine",
- "name": "vmstate",
- "type": "string"
- },
- {
- "description": "the account associated with the disk volume",
- "name": "account",
- "type": "string"
- },
- {
- "description": "Hypervisor the volume belongs to",
- "name": "hypervisor",
- "type": "string"
- },
- {
- "description": "ID of the availability zone",
- "name": "zoneid",
- "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",
- "type": "string"
- },
- {
- "description": "size of the disk volume",
- "name": "size",
- "type": "long"
- },
- {
- "description": "the ID of the ISO attached to the virtual machine",
- "name": "isoid",
- "type": "string"
- },
- {},
- {
"description": "ID of the disk offering",
"name": "diskofferingid",
"type": "string"
},
{
- "description": "the date the disk volume was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the name of the template for the virtual machine",
- "name": "templatename",
- "type": "string"
- },
- {
- "description": "name of the availability zone",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "provisioning type used to create volumes.",
- "name": "provisioningtype",
- "type": "string"
- },
- {
- "description": "the state of the disk volume",
- "name": "state",
- "type": "string"
- },
- {
- "description": "name of the disk offering",
- "name": "diskofferingname",
- "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 disk utilization",
- "name": "utilization",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the disk volume",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "true if the volume is extractable, false otherwise",
- "name": "isextractable",
- "type": "boolean"
- },
- {
- "description": "need quiesce vm or not when taking snapshot",
- "name": "quiescevm",
- "type": "boolean"
- },
- {
- "description": "the project name of the vpn",
- "name": "project",
- "type": "string"
- },
- {
"description": "io requests read rate of the disk volume per the disk offering",
"name": "diskIopsReadRate",
"type": "long"
},
{
- "description": "true if storage snapshot is supported for the volume, false otherwise",
- "name": "supportsstoragesnapshot",
- "type": "boolean"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the status of the volume",
- "name": "status",
- "type": "string"
- },
- {
- "description": "name of the primary storage hosting the disk volume",
- "name": "storage",
- "type": "string"
- },
- {
- "description": "cluster name where the volume is allocated",
- "name": "clustername",
- "type": "string"
- },
- {
- "description": "id of the primary storage hosting the disk volume; returned to admin user only",
- "name": "storageid",
- "type": "string"
- },
- {
- "description": "the display text of the service offering for root disk",
- "name": "serviceofferingdisplaytext",
- "type": "string"
- },
- {
- "description": "the bytes allocated",
- "name": "physicalsize",
+ "description": "the read (bytes) of disk on the vm",
+ "name": "diskkbsread",
"type": "long"
},
{
+ "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": "type of the disk volume (ROOT or DATADISK)",
"name": "type",
"type": "string"
},
{
- "description": "an optional field whether to the display the volume to the end user or not.",
- "name": "displayvolume",
+ "description": "need quiesce vm or not when taking snapshot",
+ "name": "quiescevm",
"type": "boolean"
},
{
- "description": "name of the service offering for root disk",
- "name": "serviceofferingname",
+ "description": "the boolean state of whether the volume is destroyed or not",
+ "name": "destroyed",
+ "type": "boolean"
+ },
+ {
+ "description": "the 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"
},
{
@@ -99878,23 +101321,13 @@
"type": "string"
},
{
- "description": "the write (io) of disk on the vm",
- "name": "diskiowrite",
- "type": "long"
+ "description": "true if storage snapshot is supported for the volume, false otherwise",
+ "name": "supportsstoragesnapshot",
+ "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": "min iops of the disk volume",
- "name": "miniops",
- "type": "long"
- },
- {
- "description": "the display text of the disk offering",
- "name": "diskofferingdisplaytext",
+ "description": "cluster id of the volume",
+ "name": "clusterid",
"type": "string"
},
{
@@ -99903,8 +101336,13 @@
"type": "long"
},
{
- "description": "shared or local storage",
- "name": "storagetype",
+ "description": "the project id of the vpn",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "pod id of the volume",
+ "name": "podid",
"type": "string"
},
{
@@ -99913,20 +101351,30 @@
"type": "date"
},
{
- "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.",
- "name": "deviceid",
- "type": "long"
- },
- {
"description": "the list of resource tags associated",
"name": "tags",
"response": [
{
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
"description": "resource type",
"name": "resourcetype",
"type": "string"
},
{
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
"description": "the account associated with the tag",
"name": "account",
"type": "string"
@@ -99937,21 +101385,6 @@
"type": "string"
},
{
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
"description": "id of the resource",
"name": "resourceid",
"type": "string"
@@ -99962,46 +101395,26 @@
"type": "string"
},
{
- "description": "the domain associated with the tag",
- "name": "domain",
+ "description": "the project name where tag belongs to",
+ "name": "project",
"type": "string"
},
{
- "description": "tag value",
- "name": "value",
+ "description": "tag key name",
+ "name": "key",
"type": "string"
}
],
"type": "set"
},
{
- "description": "an alternate display text of the ISO attached to the virtual machine",
- "name": "isodisplaytext",
- "type": "string"
+ "description": "true if the volume is extractable, false otherwise",
+ "name": "isextractable",
+ "type": "boolean"
},
{
- "description": "the path of the volume",
- "name": "path",
- "type": "string"
- },
- {
- "description": "ID of the disk volume",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the read (bytes) of disk on the vm",
- "name": "diskkbsread",
- "type": "long"
- },
- {
- "description": "max iops of the disk volume",
- "name": "maxiops",
- "type": "long"
- },
- {
- "description": "ID of the service offering for root disk",
- "name": "serviceofferingid",
+ "description": "name of the availability zone",
+ "name": "zonename",
"type": "string"
},
{
@@ -100010,53 +101423,13 @@
"type": "long"
},
{
- "description": "the name of the ISO attached to the virtual machine",
- "name": "isoname",
+ "description": "ID of the disk volume",
+ "name": "id",
"type": "string"
},
{
- "description": "the bytes actually consumed on disk",
- "name": "virtualsize",
- "type": "long"
- },
- {
- "description": "the boolean state of whether the volume is destroyed or not",
- "name": "destroyed",
- "type": "boolean"
- },
- {
- "description": "cluster id of the volume",
- "name": "clusterid",
- "type": "string"
- },
- {
- "description": "pod name of the volume",
- "name": "podname",
- "type": "string"
- },
- {
- "description": "id of the virtual machine",
- "name": "virtualmachineid",
- "type": "string"
- },
- {
- "description": "bytes write rate of the disk volume",
- "name": "diskBytesWriteRate",
- "type": "long"
- },
- {
- "description": "the chain info of the volume",
- "name": "chaininfo",
- "type": "string"
- },
- {
- "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"
},
{
@@ -100065,9 +101438,211 @@
"type": "string"
},
{
+ "description": "an optional field whether to the display the volume to the end user or not.",
+ "name": "displayvolume",
+ "type": "boolean"
+ },
+ {
+ "description": "the status of the volume",
+ "name": "status",
+ "type": "string"
+ },
+ {
+ "description": "name of the virtual machine",
+ "name": "vmname",
+ "type": "string"
+ },
+ {
+ "description": "provisioning type used to create volumes.",
+ "name": "provisioningtype",
+ "type": "string"
+ },
+ {
+ "description": "min iops of the disk volume",
+ "name": "miniops",
+ "type": "long"
+ },
+ {
+ "description": "the account associated with the disk volume",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the disk volume",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the date the disk volume was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "cluster name where the volume is allocated",
+ "name": "clustername",
+ "type": "string"
+ },
+ {
+ "description": "the name of the ISO attached to the virtual machine",
+ "name": "isoname",
+ "type": "string"
+ },
+ {
"description": "name of the disk volume",
"name": "name",
"type": "string"
+ },
+ {
+ "description": "the bytes actually consumed on disk",
+ "name": "virtualsize",
+ "type": "long"
+ },
+ {
+ "description": "name of the disk offering",
+ "name": "diskofferingname",
+ "type": "string"
+ },
+ {
+ "description": "bytes write rate of the disk volume",
+ "name": "diskBytesWriteRate",
+ "type": "long"
+ },
+ {
+ "description": "id of the primary storage hosting the disk volume; returned to admin user only",
+ "name": "storageid",
+ "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 state of the disk volume",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "size of the disk volume",
+ "name": "size",
+ "type": "long"
+ },
+ {
+ "description": "ID of the availability zone",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the chain info of the volume",
+ "name": "chaininfo",
+ "type": "string"
+ },
+ {
+ "description": "the name of the template for the virtual machine",
+ "name": "templatename",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the vpn",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "name of the primary storage hosting the disk volume",
+ "name": "storage",
+ "type": "string"
+ },
+ {
+ "description": "the display text of the service offering for root disk",
+ "name": "serviceofferingdisplaytext",
+ "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 template for the virtual machine",
+ "name": "templatedisplaytext",
+ "type": "string"
+ },
+ {
+ "description": "the path of the volume",
+ "name": "path",
+ "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": "shared or local storage",
+ "name": "storagetype",
+ "type": "string"
+ },
+ {
+ "description": "the bytes allocated",
+ "name": "physicalsize",
+ "type": "long"
+ },
+ {},
+ {
+ "description": "id of the virtual machine",
+ "name": "virtualmachineid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.",
+ "name": "deviceid",
+ "type": "long"
+ },
+ {
+ "description": "an alternate display text of the ISO attached to the virtual machine",
+ "name": "isodisplaytext",
+ "type": "string"
+ },
+ {
+ "description": "ID of the service offering for root disk",
+ "name": "serviceofferingid",
+ "type": "string"
+ },
+ {
+ "description": "the display text of the disk offering",
+ "name": "diskofferingdisplaytext",
+ "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 ID of the domain associated with the disk volume",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "max iops of the disk volume",
+ "name": "maxiops",
+ "type": "long"
}
]
},
@@ -100077,6 +101652,21 @@
"name": "listF5LoadBalancerNetworks",
"params": [
{
+ "description": "f5 load balancer device ID",
+ "length": 255,
+ "name": "lbdeviceid",
+ "related": "",
+ "required": true,
+ "type": "uuid"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
"description": "List by keyword",
"length": 255,
"name": "keyword",
@@ -100086,191 +101676,36 @@
{
"description": "",
"length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
- },
- {
- "description": "",
- "length": 255,
"name": "page",
"required": false,
"type": "integer"
- },
- {
- "description": "f5 load balancer device ID",
- "length": 255,
- "name": "lbdeviceid",
- "related": "",
- "required": true,
- "type": "uuid"
}
],
"related": "createNetwork,updateNetwork,listNetworks",
"response": [
{
- "description": "related to what other network configuration",
- "name": "related",
- "type": "string"
- },
- {
- "description": "name of the network offering the network is created from",
- "name": "networkofferingname",
- "type": "string"
- },
- {
- "description": "the name of the zone the network belongs to",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "true if network can span multiple zones",
- "name": "strechedl2subnet",
- "type": "boolean"
- },
- {
- "description": "the domain id of the network owner",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "zone id of the network",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "If the network has redundant routers enabled",
- "name": "redundantrouter",
- "type": "boolean"
- },
- {
- "description": "the id of the network",
- "name": "id",
- "type": "string"
- },
- {
- "description": "true if users from subdomains can access the domain level network",
- "name": "subdomainaccess",
- "type": "boolean"
- },
- {
- "description": "the project name of the address",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE",
- "name": "networkcidr",
- "type": "string"
- },
- {
- "description": "true if network is system, false otherwise",
- "name": "issystem",
- "type": "boolean"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "an optional field, whether to the display the network to the end user or not.",
- "name": "displaynetwork",
- "type": "boolean"
- },
- {
- "description": "true if network supports specifying ip ranges, false otherwise",
- "name": "specifyipranges",
- "type": "boolean"
- },
- {
- "description": "the name of the network",
- "name": "name",
- "type": "string"
- },
- {
"description": "state of the network",
"name": "state",
"type": "string"
},
{
- "description": "the second DNS for the network",
- "name": "dns2",
- "type": "string"
- },
- {
"description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR",
"name": "cidr",
"type": "string"
},
{
- "description": "the project id of the ipaddress",
- "name": "projectid",
+ "description": "related to what other network configuration",
+ "name": "related",
"type": "string"
},
{
- "description": "list networks that are persistent",
- "name": "ispersistent",
- "type": "boolean"
- },
- {
- "description": "broadcast uri of the network. This parameter is visible to ROOT admins only",
- "name": "broadcasturi",
+ "description": "acl type - access type to the network",
+ "name": "acltype",
"type": "string"
},
{
- "description": "network offering id the network is created from",
- "name": "networkofferingid",
- "type": "string"
- },
- {
- "description": "The external id of the network",
- "name": "externalid",
- "type": "string"
- },
- {
- "description": "Broadcast domain type of the network",
- "name": "broadcastdomaintype",
- "type": "string"
- },
- {
- "description": "Name of the VPC to which this network belongs",
- "name": "vpcname",
- "type": "string"
- },
- {
- "description": "the physical network id",
- "name": "physicalnetworkid",
- "type": "string"
- },
- {
- "description": "true if network is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
- },
- {
- "description": "the date this network was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "The vlan of the network. This parameter is visible to ROOT admins only",
- "name": "vlan",
- "type": "string"
- },
- {
- "description": "the total number of network traffic bytes sent",
- "name": "sentbytes",
- "type": "long"
- },
- {
- "description": "the first DNS for the network",
- "name": "dns1",
+ "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"
},
{
@@ -100278,124 +101713,77 @@
"name": "networkofferingdisplaytext",
"type": "string"
},
- {},
{
- "description": "the details of the network",
- "name": "details",
- "type": "map"
- },
- {
- "description": "VPC the network belongs to",
- "name": "vpcid",
+ "description": "the network's netmask",
+ "name": "netmask",
"type": "string"
},
{
- "description": "the type of the network",
- "name": "type",
- "type": "string"
- },
- {
- "description": "the displaytext of the network",
- "name": "displaytext",
- "type": "string"
- },
- {
- "description": "availability of the network offering the network is created from",
- "name": "networkofferingavailability",
- "type": "string"
- },
- {
- "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans",
- "name": "zonesnetworkspans",
- "type": "set"
- },
- {
"description": "ACL name associated with the VPC network",
"name": "aclname",
"type": "string"
},
{
- "description": "list networks available for vm deployment",
- "name": "canusefordeploy",
+ "description": "If the network has redundant routers enabled",
+ "name": "redundantrouter",
"type": "boolean"
},
{
- "description": "the list of resource tags associated with network",
- "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": "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": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- }
- ],
- "type": "list"
+ "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",
- "type": "string"
- },
- {
- "description": "the gateway of IPv6 network",
- "name": "ip6gateway",
- "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 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": "uuid of the network provider",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the physical network this belongs to",
+ "name": "physicalnetworkid",
+ "type": "string"
+ },
+ {
"description": "the provider name",
"name": "name",
"type": "string"
@@ -100406,76 +101794,65 @@
"type": "string"
},
{
- "description": "uuid of the network provider",
- "name": "id",
- "type": "string"
- },
- {
- "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": "true if individual services can be enabled/disabled",
- "name": "canenableindividualservice",
- "type": "boolean"
- }
- ],
- "type": "list"
- },
- {
- "description": "the list of capabilities",
- "name": "capability",
- "response": [
- {
- "description": "can this service capability value can be choosable while creatine network offerings",
- "name": "canchooseservicecapability",
- "type": "boolean"
- },
- {
- "description": "the capability name",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the capability value",
- "name": "value",
+ "description": "the destination physical network",
+ "name": "destinationphysicalnetworkid",
"type": "string"
}
],
"type": "list"
- },
- {
- "description": "the service name",
- "name": "name",
- "type": "string"
}
],
"type": "list"
},
{
- "description": "true network requires restart",
- "name": "restartrequired",
- "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": "ACL Id associated with the VPC network",
- "name": "aclid",
+ "description": "VPC the network belongs to",
+ "name": "vpcid",
"type": "string"
},
{
- "description": "the network's netmask",
- "name": "netmask",
+ "description": "the second DNS for the network",
+ "name": "dns2",
+ "type": "string"
+ },
+ {
+ "description": "the displaytext of the network",
+ "name": "displaytext",
+ "type": "string"
+ },
+ {
+ "description": "the type of the network",
+ "name": "type",
+ "type": "string"
+ },
+ {
+ "description": "the total number of network traffic bytes received",
+ "name": "receivedbytes",
+ "type": "long"
+ },
+ {
+ "description": "the id of the network",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the date this network was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "Name of the VPC to which this network belongs",
+ "name": "vpcname",
"type": "string"
},
{
@@ -100484,8 +101861,13 @@
"type": "string"
},
{
- "description": "the owner of the network",
- "name": "account",
+ "description": "ACL Id associated with the VPC network",
+ "name": "aclid",
+ "type": "string"
+ },
+ {
+ "description": "the traffic type of the network",
+ "name": "traffictype",
"type": "string"
},
{
@@ -100494,13 +101876,13 @@
"type": "integer"
},
{
- "description": "the traffic type of the network",
- "name": "traffictype",
- "type": "string"
+ "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans",
+ "name": "zonesnetworkspans",
+ "type": "set"
},
{
- "description": "the network's gateway",
- "name": "gateway",
+ "description": "the domain id of the network owner",
+ "name": "domainid",
"type": "string"
},
{
@@ -100509,13 +101891,63 @@
"type": "resourceiconresponse"
},
{
- "description": "the total number of network traffic bytes received",
- "name": "receivedbytes",
+ "description": "the network's gateway",
+ "name": "gateway",
+ "type": "string"
+ },
+ {
+ "description": "the name of the zone the network belongs to",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "the total number of network traffic bytes sent",
+ "name": "sentbytes",
"type": "long"
},
{
- "description": "acl type - access type to the network",
- "name": "acltype",
+ "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": "availability of the network offering the network is created from",
+ "name": "networkofferingavailability",
+ "type": "string"
+ },
+ {
+ "description": "the first DNS for the network",
+ "name": "dns1",
+ "type": "string"
+ },
+ {
+ "description": "the name of the network",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the physical network id",
+ "name": "physicalnetworkid",
+ "type": "string"
+ },
+ {
+ "description": "the gateway of IPv6 network",
+ "name": "ip6gateway",
+ "type": "string"
+ },
+ {
+ "description": "The vlan of the network. This parameter is visible to ROOT admins only",
+ "name": "vlan",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the address",
+ "name": "project",
"type": "string"
},
{
@@ -100524,14 +101956,157 @@
"type": "string"
},
{
- "description": "the domain name of the network owner",
- "name": "domain",
+ "description": "the details of the network",
+ "name": "details",
+ "type": "map"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
+ "description": "Broadcast domain type of the network",
+ "name": "broadcastdomaintype",
+ "type": "string"
+ },
+ {
+ "description": "an optional field, whether to the display the network to the end user or not.",
+ "name": "displaynetwork",
+ "type": "boolean"
+ },
+ {
+ "description": "true network requires restart",
+ "name": "restartrequired",
+ "type": "boolean"
+ },
+ {
"description": "true if network offering is ip conserve mode enabled",
"name": "networkofferingconservemode",
"type": "boolean"
+ },
+ {
+ "description": "The external id of the network",
+ "name": "externalid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "true if network supports specifying ip ranges, false otherwise",
+ "name": "specifyipranges",
+ "type": "boolean"
+ },
+ {
+ "description": "list networks available for vm deployment",
+ "name": "canusefordeploy",
+ "type": "boolean"
+ },
+ {
+ "description": "zone id of the network",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "broadcast uri of the network. This parameter is visible to ROOT admins only",
+ "name": "broadcasturi",
+ "type": "string"
+ },
+ {
+ "description": "the list of resource tags associated with network",
+ "name": "tags",
+ "response": [
+ {
+ "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": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ }
+ ],
+ "type": "list"
+ },
+ {
+ "description": "the domain name of the network owner",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "true if network can span multiple zones",
+ "name": "strechedl2subnet",
+ "type": "boolean"
+ },
+ {
+ "description": "the owner of the network",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "true if network is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {
+ "description": "the project id of the ipaddress",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "true if users from subdomains can access the domain level network",
+ "name": "subdomainaccess",
+ "type": "boolean"
+ },
+ {
+ "description": "network offering id the network is created from",
+ "name": "networkofferingid",
+ "type": "string"
}
]
},
@@ -100541,59 +102116,6 @@
"name": "listVMSnapshot",
"params": [
{
- "description": "The ID of the VM snapshot",
- "length": 255,
- "name": "vmsnapshotid",
- "related": "listVMSnapshot,createVMSnapshot",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
- },
- {
- "description": "the ID of the vm",
- "length": 255,
- "name": "virtualmachineid",
- "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
- "length": 255,
- "name": "isrecursive",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "the IDs of the vm snapshots, mutually exclusive with vmsnapshotid",
- "length": 255,
- "name": "vmsnapshotids",
- "related": "listVMSnapshot,createVMSnapshot",
- "required": false,
- "since": "4.9",
- "type": "list"
- },
- {
- "description": "",
- "length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
- },
- {
- "description": "lists snapshot by snapshot name or display name",
- "length": 255,
- "name": "name",
- "required": false,
- "type": "string"
- },
- {
"description": "list resources by account. Must be used with the domainId parameter.",
"length": 255,
"name": "account",
@@ -100601,9 +102123,9 @@
"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": "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"
},
@@ -100623,6 +102145,53 @@
"type": "map"
},
{
+ "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",
+ "length": 255,
+ "name": "listall",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "The ID of the VM snapshot",
+ "length": 255,
+ "name": "vmsnapshotid",
+ "related": "listVMSnapshot,createVMSnapshot",
+ "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 IDs of the vm snapshots, mutually exclusive with vmsnapshotid",
+ "length": 255,
+ "name": "vmsnapshotids",
+ "related": "listVMSnapshot,createVMSnapshot",
+ "required": false,
+ "since": "4.9",
+ "type": "list"
+ },
+ {
+ "description": "the ID of the vm",
+ "length": 255,
+ "name": "virtualmachineid",
+ "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines",
+ "required": false,
+ "type": "uuid"
+ },
+ {
"description": "state of the virtual machine snapshot",
"length": 255,
"name": "state",
@@ -100630,6 +102199,13 @@
"type": "string"
},
{
+ "description": "lists snapshot by snapshot name or display name",
+ "length": 255,
+ "name": "name",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "",
"length": 255,
"name": "pagesize",
@@ -100637,38 +102213,84 @@
"type": "integer"
},
{
- "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": "createVMSnapshot",
"response": [
{
+ "description": "the project name of the vpn",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the vm snapshot",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the disk volume",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "VM Snapshot type",
+ "name": "type",
+ "type": "string"
+ },
+ {
"description": "the project id of the vpn",
"name": "projectid",
"type": "string"
},
{
- "description": "the parent displayName of the vm snapshot",
- "name": "parentName",
+ "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 type of hypervisor on which snapshot is stored",
+ "name": "hypervisor",
+ "type": "hypervisortype"
+ },
+ {},
+ {
+ "description": "the display name of the vm snapshot",
+ "name": "displayname",
"type": "string"
},
{
+ "description": "the vm name of the vm snapshot",
+ "name": "virtualmachinename",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the disk volume",
+ "name": "domain",
+ "type": "string"
+ },
+ {},
+ {
"description": "the list of resource tags associated",
"name": "tags",
"response": [
{
- "description": "the account associated with the tag",
- "name": "account",
+ "description": "tag value",
+ "name": "value",
"type": "string"
},
{
- "description": "resource type",
- "name": "resourcetype",
+ "description": "id of the resource",
+ "name": "resourceid",
"type": "string"
},
{
@@ -100682,16 +102304,6 @@
"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"
@@ -100702,19 +102314,74 @@
"type": "string"
},
{
- "description": "id of the resource",
- "name": "resourceid",
+ "description": "the domain associated with the tag",
+ "name": "domain",
"type": "string"
},
{
- "description": "the domain associated with the tag",
- "name": "domain",
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
"type": "string"
}
],
"type": "set"
},
{
+ "description": "the description of the vm snapshot",
+ "name": "description",
+ "type": "string"
+ },
+ {
+ "description": "the create date of the vm snapshot",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the parent displayName of the vm snapshot",
+ "name": "parentName",
+ "type": "string"
+ },
+ {
+ "description": "the vm ID of the vm snapshot",
+ "name": "virtualmachineid",
+ "type": "string"
+ },
+ {
+ "description": "the Zone name of the vm snapshot",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "indiates if this is current snapshot",
+ "name": "current",
+ "type": "boolean"
+ },
+ {
+ "description": "the Zone ID of the vm snapshot",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the parent ID of the vm snapshot",
+ "name": "parent",
+ "type": "string"
+ },
+ {
"description": "the ID of the domain associated with the disk volume",
"name": "domainid",
"type": "string"
@@ -100725,102 +102392,10 @@
"type": "integer"
},
{
- "description": "the account associated with the disk volume",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the state of the vm snapshot",
- "name": "state",
- "type": "state"
- },
- {
- "description": "the domain associated with the disk volume",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "indiates if this is current snapshot",
- "name": "current",
- "type": "boolean"
- },
- {
- "description": "the create date of the vm snapshot",
- "name": "created",
- "type": "date"
- },
- {},
- {
- "description": "VM Snapshot type",
- "name": "type",
- "type": "string"
- },
- {
- "description": "the Zone ID of the vm snapshot",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the ID of the vm snapshot",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the display name of the vm snapshot",
- "name": "displayname",
- "type": "string"
- },
- {
- "description": "the Zone name of the vm snapshot",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "the vm ID of the vm snapshot",
- "name": "virtualmachineid",
- "type": "string"
- },
- {
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "the type of hypervisor on which snapshot is stored",
- "name": "hypervisor",
- "type": "hypervisortype"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the description of the vm snapshot",
- "name": "description",
- "type": "string"
- },
- {
- "description": "the parent ID of the vm snapshot",
- "name": "parent",
- "type": "string"
- },
- {
- "description": "the project name of the vpn",
- "name": "project",
- "type": "string"
- },
- {
"description": "the name of the vm snapshot",
"name": "name",
"type": "string"
- },
- {
- "description": "the vm name of the vm snapshot",
- "name": "virtualmachinename",
- "type": "string"
- },
- {}
+ }
],
"since": "4.2.0"
},
@@ -100830,42 +102405,6 @@
"name": "updatePod",
"params": [
{
- "description": "the name of the Pod",
- "length": 255,
- "name": "name",
- "required": false,
- "type": "string"
- },
- {
- "description": "the ending IP address for the Pod",
- "length": 255,
- "name": "endip",
- "required": false,
- "type": "string"
- },
- {
- "description": "the gateway for the Pod",
- "length": 255,
- "name": "gateway",
- "required": false,
- "type": "string"
- },
- {
- "description": "Allocation state of this cluster for allocation of new resources",
- "length": 255,
- "name": "allocationstate",
- "required": false,
- "type": "string"
- },
- {
- "description": "the ID of the Pod",
- "length": 255,
- "name": "id",
- "related": "updatePod,createManagementNetworkIpRange",
- "required": true,
- "type": "uuid"
- },
- {
"description": "the starting IP address for the Pod",
"length": 255,
"name": "startip",
@@ -100878,46 +102417,52 @@
"name": "netmask",
"required": false,
"type": "string"
+ },
+ {
+ "description": "the gateway for the Pod",
+ "length": 255,
+ "name": "gateway",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the ID of the Pod",
+ "length": 255,
+ "name": "id",
+ "related": "updatePod,createManagementNetworkIpRange",
+ "required": true,
+ "type": "uuid"
+ },
+ {
+ "description": "the name of the Pod",
+ "length": 255,
+ "name": "name",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "Allocation state of this cluster for allocation of new resources",
+ "length": 255,
+ "name": "allocationstate",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the ending IP address for the Pod",
+ "length": 255,
+ "name": "endip",
+ "required": false,
+ "type": "string"
}
],
"related": "createManagementNetworkIpRange",
"response": [
{
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.",
- "name": "forsystemvms",
- "type": "list"
- },
- {
"description": "the 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 allocation state of the Pod",
"name": "allocationstate",
"type": "string"
@@ -100927,13 +102472,8 @@
"name": "capacity",
"response": [
{
- "description": "the Pod name",
- "name": "podname",
- "type": "string"
- },
- {
- "description": "the percentage of capacity currently in use",
- "name": "percentused",
+ "description": "the Zone ID",
+ "name": "zoneid",
"type": "string"
},
{
@@ -100947,6 +102487,36 @@
"type": "string"
},
{
+ "description": "the Pod ID",
+ "name": "podid",
+ "type": "string"
+ },
+ {
+ "description": "the Cluster name",
+ "name": "clustername",
+ "type": "string"
+ },
+ {
+ "description": "the percentage of capacity currently in use",
+ "name": "percentused",
+ "type": "string"
+ },
+ {
+ "description": "the Pod name",
+ "name": "podname",
+ "type": "string"
+ },
+ {
+ "description": "the total capacity available",
+ "name": "capacitytotal",
+ "type": "long"
+ },
+ {
+ "description": "the capacity currently in allocated",
+ "name": "capacityallocated",
+ "type": "long"
+ },
+ {
"description": "the capacity currently in use",
"name": "capacityused",
"type": "long"
@@ -100957,59 +102527,33 @@
"type": "string"
},
{
- "description": "the Cluster name",
- "name": "clustername",
- "type": "string"
- },
- {
- "description": "the total capacity available",
- "name": "capacitytotal",
- "type": "long"
- },
- {
"description": "the capacity name",
"name": "name",
"type": "string"
- },
- {
- "description": "the Zone ID",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the Pod ID",
- "name": "podid",
- "type": "string"
- },
- {
- "description": "the capacity currently in allocated",
- "name": "capacityallocated",
- "type": "long"
}
],
"type": "list"
},
{
- "description": "the Zone ID of the Pod",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.",
- "name": "startip",
+ "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": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.",
+ "name": "vlanid",
+ "type": "list"
},
{
"description": "the IP ranges for the Pod",
"name": "ipranges",
"response": [
{
+ "description": "the ending IP for the range",
+ "name": "endip",
+ "type": "string"
+ },
+ {
"description": "indicates if range is dedicated for CPVM and SSVM",
"name": "forsystemvms",
"type": "string"
@@ -101020,11 +102564,6 @@
"type": "string"
},
{
- "description": "the ending IP for the range",
- "name": "endip",
- "type": "string"
- },
- {
"description": "the starting IP for the range",
"name": "startip",
"type": "string"
@@ -101033,20 +102572,56 @@
"type": "list"
},
{
- "description": "the gateway of the Pod",
- "name": "gateway",
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
+ "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.",
+ "name": "startip",
+ "type": "list"
+ },
+ {
"description": "the netmask of the Pod",
"name": "netmask",
"type": "string"
},
{
- "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.",
- "name": "vlanid",
+ "description": "the ID of the Pod",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the name of the Pod",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the Zone ID of the Pod",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.",
+ "name": "forsystemvms",
"type": "list"
},
+ {},
+ {
+ "description": "the gateway of the Pod",
+ "name": "gateway",
+ "type": "string"
+ },
{}
]
},
@@ -101063,6 +102638,14 @@
"type": "string"
},
{
+ "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only",
+ "length": 255,
+ "name": "customid",
+ "required": false,
+ "since": "4.4",
+ "type": "string"
+ },
+ {
"description": "Md5 hash used to check the consistency of the ACL rule list before applying the ACL rule move. This check is useful to manage concurrency problems that may happen when multiple users are editing the same ACL rule listing. The parameter is not required. Therefore, if the user does not send it, they assume the risk of moving ACL rules without checking the consistency of the access control list before executing the move. We use MD5 hash function on a String that is composed of all UUIDs of the ACL rules in concatenated in their respective order (order defined via 'number' field).",
"length": 255,
"name": "aclconsistencyhash",
@@ -101070,137 +102653,25 @@
"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": "The ID of the network ACL rule that is being moved to a new position.",
"length": 255,
"name": "id",
"required": true,
"type": "string"
- },
- {
- "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only",
- "length": 255,
- "name": "customid",
- "required": false,
- "since": "4.4",
- "type": "string"
- },
- {
- "description": "The ID of the 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": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "error code for this icmp message",
- "name": "icmpcode",
- "type": "integer"
- },
- {
- "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).",
- "name": "cidrlist",
- "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": "type of the icmp message being sent",
- "name": "icmptype",
- "type": "integer"
- },
- {},
- {
- "description": "an explanation on why this ACL rule is being applied",
- "name": "reason",
- "type": "string"
- },
- {
- "description": "the list of resource tags associated with the network ACLs",
- "name": "tags",
- "response": [
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "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 account associated with the tag",
- "name": "account",
- "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 ID of the ACL this item belongs to",
- "name": "aclid",
+ "description": "the name of the ACL this item belongs to",
+ "name": "aclname",
"type": "string"
},
{
@@ -101209,18 +102680,28 @@
"type": "integer"
},
{
+ "description": "type of the icmp message being sent",
+ "name": "icmptype",
+ "type": "integer"
+ },
+ {
"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 protocol of the ACL",
+ "name": "protocol",
"type": "string"
},
{
- "description": "the ID of the ACL Item",
- "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 UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
@@ -101229,11 +102710,105 @@
"type": "string"
},
{
+ "description": "the ending port of ACL's port range",
+ "name": "endport",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the ACL Item",
+ "name": "id",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "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": "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 project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "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"
+ }
+ ],
+ "type": "list"
+ },
+ {
+ "description": "is rule for display to the regular user",
+ "name": "fordisplay",
+ "type": "boolean"
+ },
+ {
+ "description": "the ID of the ACL this item belongs to",
+ "name": "aclid",
+ "type": "string"
+ },
+ {
+ "description": "Number of the ACL Item",
+ "name": "number",
+ "type": "integer"
+ },
+ {
"description": "the state of the rule",
"name": "state",
"type": "string"
},
{
+ "description": "error code for this icmp message",
+ "name": "icmpcode",
+ "type": "integer"
+ },
+ {
"description": "Action of ACL Item. Allow/Deny",
"name": "action",
"type": "string"
@@ -101254,62 +102829,618 @@
"type": "boolean"
},
{
- "description": "the ID of the virtual machine",
- "length": 255,
- "name": "virtualmachineid",
- "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines",
- "required": true,
- "type": "uuid"
- },
- {
"description": "the ID of the ISO file",
"length": 255,
"name": "id",
"related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos",
"required": true,
"type": "uuid"
+ },
+ {
+ "description": "the ID of the virtual machine",
+ "length": 255,
+ "name": "virtualmachineid",
+ "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines",
+ "required": true,
+ "type": "uuid"
}
],
"related": "destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines",
"response": [
{
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
- },
- {
- "description": "the internal memory that's free in vm or zero if it can not be calculated",
- "name": "memoryintfreekbs",
- "type": "long"
- },
- {
- "description": "the ID of the virtual machine",
- "name": "id",
+ "description": "instance name of the user vm; this parameter is returned to the ROOT admin only",
+ "name": "instancename",
"type": "string"
},
{
- "description": "the memory used by the vm",
- "name": "memorykbs",
+ "description": "list of security groups associated with the virtual machine",
+ "name": "securitygroup",
+ "response": [
+ {
+ "description": "the list of resource tags associated with the rule",
+ "name": "tags",
+ "response": [
+ {
+ "description": "the 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 project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "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 domain ID of the security group",
+ "name": "domainid",
+ "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 project id of the group",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the number of virtualmachines associated with this securitygroup",
+ "name": "virtualmachinecount",
+ "type": "integer"
+ },
+ {
+ "description": "the list of egress rules associated with the security group",
+ "name": "egressrule",
+ "response": [
+ {
+ "description": "the CIDR notation for the base IP address of the security group rule",
+ "name": "cidr",
+ "type": "string"
+ },
+ {
+ "description": "the starting IP of the security group rule",
+ "name": "startport",
+ "type": "integer"
+ },
+ {
+ "description": "the protocol of the security group rule",
+ "name": "protocol",
+ "type": "string"
+ },
+ {
+ "description": "the ending IP of the security group rule ",
+ "name": "endport",
+ "type": "integer"
+ },
+ {
+ "description": "the type of the ICMP message response",
+ "name": "icmptype",
+ "type": "integer"
+ },
+ {
+ "description": "the list of resource tags associated with the rule",
+ "name": "tags",
+ "response": [
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the id of the security group rule",
+ "name": "ruleid",
+ "type": "string"
+ },
+ {
+ "description": "the code for the ICMP message response",
+ "name": "icmpcode",
+ "type": "integer"
+ },
+ {
+ "description": "security group name",
+ "name": "securitygroupname",
+ "type": "string"
+ },
+ {
+ "description": "account owning the security group rule",
+ "name": "account",
+ "type": "string"
+ }
+ ],
+ "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 description of the security group",
+ "name": "description",
+ "type": "string"
+ },
+ {
+ "description": "the list of ingress rules associated with the security group",
+ "name": "ingressrule",
+ "response": [
+ {
+ "description": "security group name",
+ "name": "securitygroupname",
+ "type": "string"
+ },
+ {
+ "description": "the starting IP of the security group rule",
+ "name": "startport",
+ "type": "integer"
+ },
+ {
+ "description": "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 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",
+ "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": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the 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 domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the CIDR notation for the base IP address of the security group rule",
+ "name": "cidr",
+ "type": "string"
+ },
+ {
+ "description": "the id of the security group rule",
+ "name": "ruleid",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the project name of the group",
+ "name": "project",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the group name of the virtual machine",
+ "name": "group",
+ "type": "string"
+ },
+ {
+ "description": "list of affinity groups associated with the virtual machine",
+ "name": "affinitygroup",
+ "response": [
+ {
+ "description": "the type of the affinity group",
+ "name": "type",
+ "type": "string"
+ },
+ {
+ "description": "virtual machine IDs associated with this affinity group",
+ "name": "virtualmachineIds",
+ "type": "list"
+ },
+ {
+ "description": "the description of the affinity group",
+ "name": "description",
+ "type": "string"
+ },
+ {
+ "description": "the domain name of the affinity group",
+ "name": "domain",
+ "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 name of the affinity group",
+ "name": "name",
+ "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 project name of the affinity group",
+ "name": "project",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.",
+ "name": "templateid",
+ "type": "string"
+ },
+ {
+ "description": "the date when this virtual machine was updated last time",
+ "name": "lastupdated",
+ "type": "date"
+ },
+ {
+ "description": "the outgoing network traffic on the host",
+ "name": "networkkbswrite",
"type": "long"
},
{
- "description": "the virtual network for the service offering",
- "name": "forvirtualnetwork",
+ "description": "the ID of the disk offering of the virtual machine",
+ "name": "diskofferingid",
+ "type": "string"
+ },
+ {
+ "description": "the list of nics associated with vm",
+ "name": "nic",
+ "response": [
+ {
+ "description": "Type of adapter if available",
+ "name": "adaptertype",
+ "type": "string"
+ },
+ {
+ "description": "ID of the 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",
+ "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 Secondary ipv4 addr of nic",
+ "name": "secondaryip",
+ "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": "device id for the network when plugged into the virtual machine",
+ "name": "deviceid",
+ "type": "string"
+ },
+ {
+ "description": "the isolation uri of the nic",
+ "name": "isolationuri",
+ "type": "string"
+ },
+ {
+ "description": "the broadcast uri of the nic",
+ "name": "broadcasturi",
+ "type": "string"
+ },
+ {
+ "description": "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 corresponding network",
+ "name": "networkid",
+ "type": "string"
+ },
+ {
+ "description": "the gateway of the nic",
+ "name": "gateway",
+ "type": "string"
+ },
+ {
+ "description": "the ip address of the nic",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "the cidr of IPv6 network",
+ "name": "ip6cidr",
+ "type": "string"
+ },
+ {
+ "description": "the extra dhcp options on the nic",
+ "name": "extradhcpoption",
+ "type": "list"
+ },
+ {
+ "description": "Id of the NSX Logical Switch (if NSX based), null otherwise",
+ "name": "nsxlogicalswitch",
+ "type": "string"
+ },
+ {
+ "description": "true if nic is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {
+ "description": "the ID of the nic",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the IPv6 address of network",
+ "name": "ip6address",
+ "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": "the name of the corresponding network",
+ "name": "networkname",
+ "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 current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the number of cpu this virtual machine is running with",
+ "name": "cpunumber",
+ "type": "integer"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
"type": "boolean"
},
{
- "description": "the ID of the service offering of the virtual machine",
- "name": "serviceofferingid",
+ "description": "the read (bytes) of disk on the vm",
+ "name": "diskkbsread",
+ "type": "long"
+ },
+ {
+ "description": "the group ID of the virtual machine",
+ "name": "groupid",
"type": "string"
},
{
- "description": " an alternate display text of the template for the virtual machine",
- "name": "templatedisplaytext",
+ "description": "Os type ID of the virtual machine",
+ "name": "guestosid",
"type": "string"
},
{
- "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"
},
{
@@ -101318,13 +103449,190 @@
"type": "string"
},
{
+ "description": "Guest vm Boot Mode",
+ "name": "bootmode",
+ "type": "string"
+ },
+ {
+ "description": "public IP address id associated with vm via Static nat rule",
+ "name": "publicipid",
+ "type": "string"
+ },
+ {
+ "description": "the pool type of the virtual machine",
+ "name": "pooltype",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "ssh key-pair",
+ "name": "keypair",
+ "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": "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": "List of read-only Vm details as comma separated string.",
+ "name": "readonlydetails",
+ "type": "string"
+ },
+ {
+ "description": "the name of the ISO attached to the virtual machine",
+ "name": "isoname",
+ "type": "string"
+ },
+ {
+ "description": "an alternate display text of the ISO attached to the virtual machine",
+ "name": "isodisplaytext",
+ "type": "string"
+ },
+ {
"description": "the name of the virtual machine",
"name": "name",
"type": "string"
},
{
- "description": "the 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 internal memory that's free in vm or zero if it can not be calculated",
+ "name": "memoryintfreekbs",
+ "type": "long"
+ },
+ {
+ "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 ID of the host for the virtual machine",
+ "name": "hostid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the host for the virtual machine",
+ "name": "hostname",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "public IP address id associated with vm via Static nat rule",
+ "name": "publicip",
+ "type": "string"
+ },
+ {
+ "description": "the name of the disk offering of the virtual machine",
+ "name": "diskofferingname",
+ "type": "string"
+ },
+ {
+ "description": "the vgpu type used by the virtual machine",
+ "name": "vgpu",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the backup offering of the virtual machine",
+ "name": "backupofferingid",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the speed of each cpu",
+ "name": "cpuspeed",
+ "type": "integer"
+ },
+ {
+ "description": "the memory used by the vm",
+ "name": "memorykbs",
+ "type": "long"
+ },
+ {
+ "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": "true if high-availability is enabled, false otherwise",
+ "name": "haenable",
+ "type": "boolean"
+ },
+ {
+ "description": "the virtual network for the service offering",
+ "name": "forvirtualnetwork",
+ "type": "boolean"
+ },
+ {
+ "description": "the incoming network traffic on the vm",
+ "name": "networkkbsread",
+ "type": "long"
+ },
+ {
+ "description": "OS name of the vm",
+ "name": "osdisplayname",
+ "type": "string"
+ },
+ {
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "description": "device ID of the root volume",
+ "name": "rootdeviceid",
+ "type": "long"
+ },
+ {
+ "description": "the read (io) of disk on the vm",
+ "name": "diskioread",
+ "type": "long"
+ },
+ {
+ "description": "the ID of the availablility zone for the virtual machine",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the user's ID who deployed the virtual machine",
+ "name": "userid",
+ "type": "string"
+ },
+ {
+ "description": "true if the password rest feature is enabled, false otherwise",
+ "name": "passwordenabled",
+ "type": "boolean"
+ },
+ {
+ "description": "the ID of the virtual machine",
+ "name": "id",
"type": "string"
},
{
@@ -101332,21 +103640,16 @@
"name": "tags",
"response": [
{
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
"description": "the domain associated with the tag",
"name": "domain",
"type": "string"
},
{
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
"description": "the account associated with the tag",
"name": "account",
"type": "string"
@@ -101367,13 +103670,18 @@
"type": "string"
},
{
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
+ "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 ID of the domain associated with the tag",
+ "name": "domainid",
"type": "string"
},
{
@@ -101385,752 +103693,38 @@
"type": "set"
},
{
- "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 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": "the memory allocated for the virtual machine",
- "name": "memory",
- "type": "integer"
- },
- {
- "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": "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 account owning the affinity group",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the project ID of the affinity group",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the name of the affinity group",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the ID of the affinity group",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the description of the affinity group",
- "name": "description",
- "type": "string"
- },
- {
- "description": "the domain name of the affinity group",
- "name": "domain",
- "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"
- }
- ],
- "type": "set"
- },
- {
- "description": "Os type ID of the virtual machine",
- "name": "guestosid",
- "type": "string"
- },
- {
- "description": "the ID of the disk offering of the virtual machine",
- "name": "diskofferingid",
- "type": "string"
- },
- {
- "description": "the ID of the availablility zone for the virtual machine",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the vgpu type used by the virtual machine",
- "name": "vgpu",
- "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"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "Guest vm Boot Mode",
- "name": "bootmode",
- "type": "string"
- },
- {},
- {
- "description": "the ID of the backup offering of the virtual machine",
- "name": "backupofferingid",
- "type": "string"
- },
- {
- "description": "the list of nics associated with vm",
- "name": "nic",
- "response": [
- {
- "description": "IP addresses associated with NIC found for unmanaged VM",
- "name": "ipaddresses",
- "type": "list"
- },
- {
- "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise",
- "name": "nsxlogicalswitchport",
- "type": "string"
- },
- {
- "description": "the isolation uri of the nic",
- "name": "isolationuri",
- "type": "string"
- },
- {
- "description": "the isolated private VLAN type if available",
- "name": "isolatedpvlantype",
- "type": "string"
- },
- {
- "description": "the cidr of IPv6 network",
- "name": "ip6cidr",
- "type": "string"
- },
- {
- "description": "the broadcast uri of the nic",
- "name": "broadcasturi",
- "type": "string"
- },
- {
- "description": "Id of the vm to which the nic belongs",
- "name": "virtualmachineid",
- "type": "string"
- },
- {
- "description": "the 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 gateway of IPv6 network",
- "name": "ip6gateway",
- "type": "string"
- },
- {
- "description": "Type of adapter if available",
- "name": "adaptertype",
- "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 ID of the nic",
- "name": "id",
- "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 gateway of the nic",
- "name": "gateway",
- "type": "string"
- },
- {
- "description": "true if nic is default, false otherwise",
- "name": "macaddress",
- "type": "string"
- },
- {
- "description": "true if nic is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
- },
- {
- "description": "the name of the corresponding network",
- "name": "networkname",
- "type": "string"
- },
- {
- "description": "the IPv6 address of network",
- "name": "ip6address",
- "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 type of the nic",
- "name": "type",
- "type": "string"
- },
- {
- "description": "the Secondary ipv4 addr of nic",
- "name": "secondaryip",
- "type": "list"
- },
- {
- "description": "the traffic type of the nic",
- "name": "traffictype",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "true if the password rest feature is enabled, false otherwise",
- "name": "passwordenabled",
- "type": "boolean"
- },
- {
- "description": "the total number of network traffic bytes sent",
- "name": "sentbytes",
+ "description": "the write (bytes) of disk on the vm",
+ "name": "diskkbswrite",
"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"
},
{
- "description": "the incoming network traffic on the vm",
- "name": "networkkbsread",
- "type": "long"
- },
- {
- "description": "public IP address id associated with vm via Static nat rule",
- "name": "publicipid",
- "type": "string"
- },
- {
- "description": "the pool type of the virtual machine",
- "name": "pooltype",
- "type": "string"
- },
- {
- "description": "the target memory in vm",
- "name": "memorytargetkbs",
- "type": "long"
- },
- {
- "description": "the ID of the ISO attached to the virtual machine",
- "name": "isoid",
- "type": "string"
- },
- {
- "description": "the read (io) of disk on the vm",
- "name": "diskioread",
- "type": "long"
- },
- {
- "description": "the name of the disk offering of the virtual machine",
- "name": "diskofferingname",
- "type": "string"
- },
- {},
- {},
- {
- "description": "the amount of the vm's CPU currently used",
- "name": "cpuused",
- "type": "string"
- },
- {
- "description": "an optional field whether to the display the vm to the end user or not.",
- "name": "displayvm",
- "type": "boolean"
- },
- {
- "description": "the total number of network traffic bytes received",
- "name": "receivedbytes",
- "type": "long"
- },
- {
- "description": "OS name of the vm",
- "name": "osdisplayname",
- "type": "string"
- },
- {
- "description": "the account associated with the virtual machine",
- "name": "account",
- "type": "string"
- },
- {
- "description": "Vm details in key/value pairs.",
- "name": "details",
- "type": "map"
- },
- {
- "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.",
- "name": "isdynamicallyscalable",
- "type": "boolean"
- },
- {
- "description": "the user's ID who deployed the virtual machine",
- "name": "userid",
- "type": "string"
- },
- {
- "description": "the read (bytes) of disk on the vm",
- "name": "diskkbsread",
- "type": "long"
- },
- {
- "description": "device ID of the root volume",
- "name": "rootdeviceid",
- "type": "long"
- },
- {
- "description": "device type of the root volume",
- "name": "rootdevicetype",
- "type": "string"
- },
- {
- "description": "list of security groups associated with the virtual machine",
- "name": "securitygroup",
- "response": [
- {
- "description": "the list of resource tags associated with the rule",
- "name": "tags",
- "response": [
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "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 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": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the number of virtualmachines associated with this securitygroup",
- "name": "virtualmachinecount",
- "type": "integer"
- },
- {
- "description": "the project name of the group",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the project id of the group",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the list of virtualmachine ids associated with this securitygroup",
- "name": "virtualmachineids",
- "type": "set"
- },
- {
- "description": "the name of the security group",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the list of ingress rules associated with the security group",
- "name": "ingressrule",
- "response": [
- {
- "description": "the type of the ICMP message response",
- "name": "icmptype",
- "type": "integer"
- },
- {
- "description": "the id of the security group rule",
- "name": "ruleid",
- "type": "string"
- },
- {
- "description": "the code for the ICMP message response",
- "name": "icmpcode",
- "type": "integer"
- },
- {
- "description": "the list of resource tags associated with the rule",
- "name": "tags",
- "response": [
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the 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 value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the protocol of the security group rule",
- "name": "protocol",
- "type": "string"
- },
- {
- "description": "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 ending IP of the security group rule ",
- "name": "endport",
- "type": "integer"
- }
- ],
- "type": "set"
- },
- {
- "description": "the description of the security group",
- "name": "description",
- "type": "string"
- },
- {
- "description": "the 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": "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 code for the ICMP message response",
- "name": "icmpcode",
- "type": "integer"
- },
- {
- "description": "the CIDR notation for the base IP address of the security group rule",
- "name": "cidr",
- "type": "string"
- },
- {
- "description": "the starting IP of the security group rule",
- "name": "startport",
- "type": "integer"
- },
- {
- "description": "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 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 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": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "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"
- }
- ],
- "type": "set"
- }
- ],
- "type": "set"
- },
- {
- "description": "the ID of the security group",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the domain ID of the security group",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the account owning the security group",
- "name": "account",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the number of cpu this virtual machine is running with",
- "name": "cpunumber",
- "type": "integer"
- },
- {
"description": "Guest vm Boot Type",
"name": "boottype",
"type": "string"
},
{
- "description": "the date when this virtual machine was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "ssh key-pair",
- "name": "keypair",
- "type": "string"
- },
- {
"description": "the name of the backup offering of the virtual machine",
"name": "backupofferingname",
"type": "string"
},
{
- "description": "the group name of the virtual machine",
- "name": "group",
+ "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": "the name of the domain in which the virtual machine exists",
+ "name": "domain",
"type": "string"
},
{
@@ -102138,9 +103732,50 @@
"name": "password",
"type": "string"
},
+ {},
{
- "description": "List of read-only Vm details as comma separated string.",
- "name": "readonlydetails",
+ "description": "the target memory in vm",
+ "name": "memorytargetkbs",
+ "type": "long"
+ },
+ {
+ "description": "device type of the root volume",
+ "name": "rootdevicetype",
+ "type": "string"
+ },
+ {
+ "description": "the total number of network traffic bytes sent",
+ "name": "sentbytes",
+ "type": "long"
+ },
+ {
+ "description": "the ID of the ISO attached to the virtual machine",
+ "name": "isoid",
+ "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 name who deployed the virtual machine",
+ "name": "username",
+ "type": "string"
+ },
+ {
+ "description": "an optional field whether to the display the vm to the end user or not.",
+ "name": "displayvm",
+ "type": "boolean"
+ },
+ {
+ "description": "the account associated with the virtual machine",
+ "name": "account",
"type": "string"
},
{
@@ -102149,79 +103784,19 @@
"type": "string"
},
{
- "description": "the outgoing network traffic on the host",
- "name": "networkkbswrite",
- "type": "long"
- },
- {
- "description": "the project name of the vm",
- "name": "project",
+ "description": "the name of the availability zone for the virtual machine",
+ "name": "zonename",
"type": "string"
},
{
- "description": "the speed of each cpu",
- "name": "cpuspeed",
- "type": "integer"
- },
- {
- "description": "the write (bytes) of disk on the vm",
- "name": "diskkbswrite",
- "type": "long"
- },
- {
- "description": "the name of the domain in which the virtual machine exists",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the ID of the host for the virtual machine",
- "name": "hostid",
- "type": "string"
- },
- {
- "description": "State of the Service from LB rule",
- "name": "servicestate",
- "type": "string"
- },
- {
- "description": "public IP address id associated with vm via Static nat rule",
- "name": "publicip",
- "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",
+ "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.",
+ "name": "isdynamicallyscalable",
"type": "boolean"
},
{
- "description": "the group ID of the virtual machine",
- "name": "groupid",
- "type": "string"
- },
- {
"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 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"
}
]
},
@@ -102241,27 +103816,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": "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"
- }
+ },
+ {}
]
},
{
@@ -102270,21 +103845,6 @@
"name": "listBaremetalDhcp",
"params": [
{
- "description": "the Physical Network ID",
- "length": 255,
- "name": "physicalnetworkid",
- "related": "",
- "required": true,
- "type": "uuid"
- },
- {
- "description": "",
- "length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
- },
- {
"description": "Type of DHCP device",
"length": 255,
"name": "dhcpservertype",
@@ -102299,11 +103859,12 @@
"type": "string"
},
{
- "description": "",
+ "description": "the Physical Network ID",
"length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
+ "name": "physicalnetworkid",
+ "related": "",
+ "required": true,
+ "type": "uuid"
},
{
"description": "DHCP server device ID",
@@ -102311,13 +103872,27 @@
"name": "id",
"required": false,
"type": "long"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
}
],
"related": "",
"response": [
{
- "description": "device id of ",
- "name": "id",
+ "description": "url",
+ "name": "url",
"type": "string"
},
{
@@ -102326,8 +103901,19 @@
"type": "string"
},
{
- "description": "url",
- "name": "url",
+ "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"
+ },
+ {
+ "description": "device id of ",
+ "name": "id",
"type": "string"
},
{
@@ -102335,22 +103921,11 @@
"name": "jobstatus",
"type": "integer"
},
+ {},
{
"description": "name of the provider",
"name": "provider",
"type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {},
- {},
- {
- "description": "the physical network to which this external dhcp device belongs to",
- "name": "physicalnetworkid",
- "type": "string"
}
]
},
@@ -102371,117 +103946,6 @@
"related": "cancelStorageMaintenance",
"response": [
{
- "description": "the state of the storage pool",
- "name": "state",
- "type": "storagepoolstatus"
- },
- {
- "description": "the name of the cluster for the storage pool",
- "name": "clustername",
- "type": "string"
- },
- {
- "description": "total min IOPS currently in use by volumes",
- "name": "allocatediops",
- "type": "long"
- },
- {
- "description": "the ID of the storage pool",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the Pod name of the storage pool",
- "name": "podname",
- "type": "string"
- },
- {},
- {
- "description": "the ID of the cluster for the storage pool",
- "name": "clusterid",
- "type": "string"
- },
- {
- "description": "the scope of the storage pool",
- "name": "scope",
- "type": "string"
- },
- {
- "description": "Storage provider for this pool",
- "name": "provider",
- "type": "string"
- },
- {
- "description": "the storage pool path",
- "name": "path",
- "type": "string"
- },
- {
- "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 date and time the storage pool was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the storage pool capabilities",
- "name": "storagecapabilities",
- "type": "map"
- },
- {
- "description": "the Zone ID of the storage pool",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the storage pool type",
- "name": "type",
- "type": "string"
- },
- {
- "description": "the Zone name of the storage pool",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "the Pod ID of the storage pool",
- "name": "podid",
- "type": "string"
- },
- {
- "description": "the overprovisionfactor for the storage pool",
- "name": "overprovisionfactor",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the hypervisor type of the storage pool",
- "name": "hypervisor",
- "type": "string"
- },
- {
- "description": "the IP address of the storage pool",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "description": "the name of the storage pool",
- "name": "name",
- "type": "string"
- },
- {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
@@ -102493,24 +103957,135 @@
"type": "long"
},
{
+ "description": "the ID of the storage pool",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the storage pool path",
+ "name": "path",
+ "type": "string"
+ },
+ {
+ "description": "the IP address of the storage pool",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "the storage pool capabilities",
+ "name": "storagecapabilities",
+ "type": "map"
+ },
+ {
"description": "true if this pool is suitable to migrate a volume, false otherwise",
"name": "suitableformigration",
"type": "boolean"
},
{
+ "description": "the state of the storage pool",
+ "name": "state",
+ "type": "storagepoolstatus"
+ },
+ {
+ "description": "the host's currently allocated disk size",
+ "name": "disksizeallocated",
+ "type": "long"
+ },
+ {
+ "description": "the Zone ID of the storage pool",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the Pod name of the storage pool",
+ "name": "podname",
+ "type": "string"
+ },
+ {
"description": "the total disk size of the storage pool",
"name": "disksizetotal",
"type": "long"
},
{
+ "description": "the Zone name of the storage pool",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "the scope of the storage pool",
+ "name": "scope",
+ "type": "string"
+ },
+ {
+ "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": "Storage provider for this pool",
+ "name": "provider",
+ "type": "string"
+ },
+ {
"description": "true if the entity/resource has annotations",
"name": "hasannotations",
"type": "boolean"
},
{
+ "description": "the name of the storage pool",
+ "name": "name",
+ "type": "string"
+ },
+ {
"description": "the host's currently used disk size",
"name": "disksizeused",
"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": "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 Pod ID of the storage pool",
+ "name": "podid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the storage pool type",
+ "name": "type",
+ "type": "string"
}
]
},
@@ -102521,19 +104096,16 @@
"params": [],
"related": "",
"response": [
+ {},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "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",
- "type": "string"
- },
- {
- "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com",
- "name": "searchbase",
+ "description": "Specify the distinguished name of a user with the search permission on the directory",
+ "name": "binddn",
"type": "string"
},
{
@@ -102542,15 +104114,18 @@
"type": "string"
},
{
- "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL",
- "name": "ssl",
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "DN password",
+ "name": "bindpass",
"type": "string"
},
- {},
- {},
{
- "description": "Specify the distinguished name of a user with the search permission on the directory",
- "name": "binddn",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
@@ -102559,14 +104134,14 @@
"type": "string"
},
{
- "description": "You specify a query filter here, which narrows down the users, who can be part of this domain",
- "name": "queryfilter",
+ "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL",
+ "name": "ssl",
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com",
+ "name": "searchbase",
+ "type": "string"
}
],
"since": "3.0.1"
@@ -102577,13 +104152,6 @@
"name": "createUser",
"params": [
{
- "description": "User UUID, required for adding account from external provisioning system",
- "length": 255,
- "name": "userid",
- "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 See Docs section.",
"length": 255,
"name": "password",
@@ -102591,16 +104159,23 @@
"type": "string"
},
{
- "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.",
+ "description": "User UUID, required for adding account from external provisioning system",
"length": 255,
- "name": "timezone",
+ "name": "userid",
"required": false,
"type": "string"
},
{
- "description": "Unique username.",
+ "description": "email",
"length": 255,
- "name": "username",
+ "name": "email",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "firstname",
+ "length": 255,
+ "name": "firstname",
"required": true,
"type": "string"
},
@@ -102620,53 +104195,37 @@
"type": "string"
},
{
- "description": "firstname",
- "length": 255,
- "name": "firstname",
- "required": true,
- "type": "string"
- },
- {
- "description": "email",
- "length": 255,
- "name": "email",
- "required": true,
- "type": "string"
- },
- {
"description": "Creates the user under the specified account. If no account is specified, the username will be used as the account name.",
"length": 255,
"name": "account",
"required": true,
"type": "string"
+ },
+ {
+ "description": "Unique username.",
+ "length": 255,
+ "name": "username",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.",
+ "length": 255,
+ "name": "timezone",
+ "required": false,
+ "type": "string"
}
],
"related": "getUser",
"response": [
{
- "description": "the domain ID of the user",
- "name": "domainid",
+ "description": "the user lastname",
+ "name": "lastname",
"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 name of the role",
- "name": "rolename",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the timezone user was created in",
+ "name": "timezone",
"type": "string"
},
{
@@ -102675,39 +104234,14 @@
"type": "string"
},
{
- "description": "the secret key of the user",
- "name": "secretkey",
- "type": "string"
- },
- {
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
- },
- {
- "description": "the ID of the role",
- "name": "roleid",
- "type": "string"
- },
- {
- "description": "true if user is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
- },
- {
"description": "the account type of the user",
"name": "accounttype",
"type": "short"
},
{
- "description": "the api key of the user",
- "name": "apikey",
- "type": "string"
- },
- {
- "description": "the user lastname",
- "name": "lastname",
- "type": "string"
+ "description": "the boolean value representing if the updating target is in caller's child domain",
+ "name": "iscallerchilddomain",
+ "type": "boolean"
},
{
"description": "the user state",
@@ -102715,14 +104249,14 @@
"type": "string"
},
{
- "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 date and time the user account was created",
- "name": "created",
- "type": "date"
+ "description": "true if user is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
},
{
"description": "the type of the role",
@@ -102730,18 +104264,65 @@
"type": "string"
},
{
+ "description": "the account name of the user",
+ "name": "account",
+ "type": "string"
+ },
+ {
"description": "the user email address",
"name": "email",
"type": "string"
},
{
+ "description": "the source type of the user in lowercase, such as native, ldap, saml2",
+ "name": "usersource",
+ "type": "string"
+ },
+ {
"description": "the user name",
"name": "username",
"type": "string"
},
{
- "description": "the source type of the user in lowercase, such as native, ldap, saml2",
- "name": "usersource",
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "description": "the user ID",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID of the user",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the role",
+ "name": "roleid",
+ "type": "string"
+ },
+ {
+ "description": "the date and time the user account was created",
+ "name": "created",
+ "type": "date"
+ },
+ {},
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the user firstname",
+ "name": "firstname",
+ "type": "string"
+ },
+ {
+ "description": "the name of the role",
+ "name": "rolename",
"type": "string"
},
{
@@ -102749,20 +104330,14 @@
"name": "accountid",
"type": "string"
},
- {},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the user firstname",
- "name": "firstname",
+ "description": "the api key of the user",
+ "name": "apikey",
"type": "string"
},
{
- "description": "the timezone user was created in",
- "name": "timezone",
+ "description": "the secret key of the user",
+ "name": "secretkey",
"type": "string"
}
]
@@ -102782,9 +104357,15 @@
],
"related": "",
"response": [
+ {},
{
- "description": "description of the api",
- "name": "description",
+ "description": "version of CloudStack the api was introduced in",
+ "name": "since",
+ "type": "string"
+ },
+ {
+ "description": "the name of the api command",
+ "name": "name",
"type": "string"
},
{
@@ -102792,10 +104373,42 @@
"name": "jobid",
"type": "string"
},
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "api response fields",
+ "name": "response",
+ "response": [
+ {
+ "description": "api response fields",
+ "name": "response",
+ "type": "set"
+ },
+ {
+ "description": "the name of the api response field",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "description of the api response field",
+ "name": "description",
+ "type": "string"
+ },
+ {
+ "description": "response field type",
+ "name": "type",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
{},
{
- "description": "the name of the api command",
- "name": "name",
+ "description": "response field type",
+ "name": "type",
"type": "string"
},
{
@@ -102809,44 +104422,27 @@
"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",
- "type": "set"
- },
- {
- "description": "the name of the api response field",
- "name": "name",
- "type": "string"
- },
- {
- "description": "response field type",
- "name": "type",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
"description": "the list params the api accepts",
"name": "params",
"response": [
{
- "description": "description of the api parameter",
- "name": "description",
+ "description": "length of the parameter",
+ "name": "length",
+ "type": "int"
+ },
+ {
+ "description": "the name of the api parameter",
+ "name": "name",
"type": "string"
},
{
- "description": "comma separated related apis to get the parameter",
- "name": "related",
+ "description": "version of CloudStack the api was introduced in",
+ "name": "since",
+ "type": "string"
+ },
+ {
+ "description": "description of the api parameter",
+ "name": "description",
"type": "string"
},
{
@@ -102855,42 +104451,21 @@
"type": "string"
},
{
- "description": "the name of the api parameter",
- "name": "name",
+ "description": "comma separated related apis to get the parameter",
+ "name": "related",
"type": "string"
},
{
"description": "true if this parameter is required for the api request",
"name": "required",
"type": "boolean"
- },
- {
- "description": "length of the parameter",
- "name": "length",
- "type": "int"
- },
- {
- "description": "version of CloudStack the api was introduced in",
- "name": "since",
- "type": "string"
}
],
"type": "set"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {},
- {
- "description": "response field type",
- "name": "type",
- "type": "string"
- },
- {
- "description": "version of CloudStack the api was introduced in",
- "name": "since",
+ "description": "description of the api",
+ "name": "description",
"type": "string"
}
],
@@ -102911,11 +104486,7 @@
}
],
"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",
@@ -102926,13 +104497,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"
- }
+ },
+ {}
]
},
{
@@ -102960,54 +104535,13 @@
"related": "",
"response": [
{
- "description": "the domain name of the owner",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the public IP address",
- "name": "publicip",
- "type": "string"
- },
- {
- "description": "the owner",
- "name": "account",
- "type": "string"
- },
- {},
- {
- "description": "the vpc name of this gateway",
- "name": "vpcname",
- "type": "string"
- },
- {
- "description": "the domain id of the owner",
- "name": "domainid",
- "type": "string"
- },
- {
"description": "the vpn gateway ID",
"name": "id",
"type": "string"
},
{
- "description": "is vpn gateway for display to the regular user",
- "name": "fordisplay",
- "type": "boolean"
- },
- {
- "description": "the 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 vpc id of this gateway",
- "name": "vpcid",
+ "description": "the domain name of the owner",
+ "name": "domain",
"type": "string"
},
{},
@@ -103017,15 +104551,56 @@
"type": "string"
},
{
- "description": "the project id",
- "name": "projectid",
+ "description": "the owner",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the date and time the host was removed",
+ "name": "removed",
+ "type": "date"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the public IP address",
+ "name": "publicip",
"type": "string"
},
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
- }
+ },
+ {
+ "description": "the vpc id of this gateway",
+ "name": "vpcid",
+ "type": "string"
+ },
+ {
+ "description": "the project id",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the domain id of the owner",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "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"
+ },
+ {}
]
},
{
@@ -103034,6 +104609,13 @@
"name": "createVMSnapshot",
"params": [
{
+ "description": "The description of the snapshot",
+ "length": 255,
+ "name": "description",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "The display name of the snapshot",
"length": 255,
"name": "name",
@@ -103061,41 +104643,13 @@
"name": "snapshotmemory",
"required": false,
"type": "boolean"
- },
- {
- "description": "The description of the snapshot",
- "length": 255,
- "name": "description",
- "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 Zone name of the vm snapshot",
- "name": "zonename",
- "type": "string"
- },
- {},
- {
- "description": "the display name of the vm snapshot",
- "name": "displayname",
- "type": "string"
- },
- {
- "description": "the description of the vm snapshot",
- "name": "description",
- "type": "string"
- },
- {
- "description": "the account associated with the disk volume",
- "name": "account",
+ "description": "the parent displayName of the vm snapshot",
+ "name": "parentName",
"type": "string"
},
{
@@ -103104,23 +104658,47 @@
"type": "string"
},
{
- "description": "the state of the vm snapshot",
- "name": "state",
- "type": "state"
+ "description": "the description of the vm snapshot",
+ "name": "description",
+ "type": "string"
},
- {},
{
- "description": "indiates if this is current snapshot",
- "name": "current",
- "type": "boolean"
+ "description": "the Zone name of the vm snapshot",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the type of hypervisor on which snapshot is stored",
+ "name": "hypervisor",
+ "type": "hypervisortype"
+ },
+ {
+ "description": "the domain associated with the disk volume",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the disk volume",
+ "name": "account",
+ "type": "string"
},
{
"description": "the list of resource tags associated",
"name": "tags",
"response": [
{
- "description": "tag value",
- "name": "value",
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
"type": "string"
},
{
@@ -103129,36 +104707,16 @@
"type": "string"
},
{
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
"description": "the project name where tag belongs to",
"name": "project",
"type": "string"
},
{
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
"description": "id of the resource",
"name": "resourceid",
"type": "string"
@@ -103167,23 +104725,69 @@
"description": "the account associated with the tag",
"name": "account",
"type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
}
],
"type": "set"
},
{
- "description": "the vm ID of the vm snapshot",
- "name": "virtualmachineid",
+ "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 id of the vpn",
+ "name": "projectid",
"type": "string"
},
{
+ "description": "the Zone ID of the vm snapshot",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {},
+ {
+ "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 ID of the vm snapshot",
"name": "id",
"type": "string"
},
{
- "description": "the Zone ID of the vm snapshot",
- "name": "zoneid",
+ "description": "indiates if this is current snapshot",
+ "name": "current",
+ "type": "boolean"
+ },
+ {
+ "description": "the display name of the vm snapshot",
+ "name": "displayname",
"type": "string"
},
{
@@ -103197,33 +104801,8 @@
"type": "string"
},
{
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "the type of hypervisor on which snapshot is stored",
- "name": "hypervisor",
- "type": "hypervisortype"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the parent displayName of the vm snapshot",
- "name": "parentName",
- "type": "string"
- },
- {
- "description": "the parent ID of the vm snapshot",
- "name": "parent",
- "type": "string"
- },
- {
- "description": "the project id of the vpn",
- "name": "projectid",
+ "description": "the ID of the domain associated with the disk volume",
+ "name": "domainid",
"type": "string"
},
{
@@ -103231,19 +104810,15 @@
"name": "created",
"type": "date"
},
+ {},
{
- "description": "the name of the vm snapshot",
- "name": "name",
+ "description": "the parent ID of the vm snapshot",
+ "name": "parent",
"type": "string"
},
{
- "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 vm ID of the vm snapshot",
+ "name": "virtualmachineid",
"type": "string"
}
],
@@ -103262,14 +104837,6 @@
"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": "Map of (key/value pairs)",
"length": 255,
"name": "details",
@@ -103282,6 +104849,14 @@
"name": "resourcetype",
"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"
}
],
"response": [
@@ -103290,23 +104865,23 @@
"name": "displaytext",
"type": "string"
},
+ {},
{
"description": "true if operation is executed successfully",
"name": "success",
"type": "boolean"
},
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
+ {},
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
- {},
- {}
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ }
]
},
{
@@ -103315,14 +104890,6 @@
"name": "listVpnUsers",
"params": [
{
- "description": "list only resources belonging to the domain specified",
- "length": 255,
- "name": "domainid",
- "related": "listDomains",
- "required": false,
- "type": "uuid"
- },
- {
"description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false",
"length": 255,
"name": "listall",
@@ -103330,25 +104897,11 @@
"type": "boolean"
},
{
- "description": "the username of the vpn user.",
+ "description": "",
"length": 255,
- "name": "username",
+ "name": "pagesize",
"required": false,
- "type": "string"
- },
- {
- "description": "list resources by account. Must be used with the domainId parameter.",
- "length": 255,
- "name": "account",
- "required": false,
- "type": "string"
- },
- {
- "description": "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"
+ "type": "integer"
},
{
"description": "list objects by project",
@@ -103359,13 +104912,6 @@
"type": "uuid"
},
{
- "description": "",
- "length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
- },
- {
"description": "List by keyword",
"length": 255,
"name": "keyword",
@@ -103373,29 +104919,68 @@
"type": "string"
},
{
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "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": "the username of the vpn user.",
+ "length": 255,
+ "name": "username",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "list only resources belonging to the domain specified",
+ "length": 255,
+ "name": "domainid",
+ "related": "listDomains",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
+ "length": 255,
+ "name": "isrecursive",
+ "required": false,
+ "type": "boolean"
+ },
+ {
"description": "The uuid of the Vpn user",
"length": 255,
"name": "id",
"related": "addVpnUser,listVpnUsers",
"required": false,
"type": "uuid"
- },
- {
- "description": "",
- "length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
}
],
"related": "addVpnUser",
"response": [
- {},
+ {
+ "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",
+ "type": "string"
+ },
{
"description": "the account of the remote access vpn",
"name": "account",
"type": "string"
},
+ {},
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
@@ -103407,18 +104992,13 @@
"type": "string"
},
{
- "description": "the domain name of the account of the remote access vpn",
- "name": "domain",
+ "description": "the state of the Vpn User",
+ "name": "state",
"type": "string"
},
{
- "description": "the project name of the vpn",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the project id of the vpn",
- "name": "projectid",
+ "description": "the username of the vpn user",
+ "name": "username",
"type": "string"
},
{
@@ -103426,21 +105006,16 @@
"name": "jobstatus",
"type": "integer"
},
+ {},
{
- "description": "the state of the Vpn User",
- "name": "state",
+ "description": "the project name of the vpn",
+ "name": "project",
"type": "string"
},
- {},
{
"description": "the vpn userID",
"name": "id",
"type": "string"
- },
- {
- "description": "the username of the vpn user",
- "name": "username",
- "type": "string"
}
]
},
@@ -103461,25 +105036,25 @@
"response": [
{},
{
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {},
+ {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
{
- "description": "any text associated with the success or failure",
- "name": "displaytext",
- "type": "string"
- },
- {
"description": "true if operation is executed successfully",
"name": "success",
"type": "boolean"
},
- {},
{
- "description": "the 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"
@@ -103500,11 +105075,12 @@
],
"response": [
{
- "description": "any text associated with the success or failure",
- "name": "displaytext",
- "type": "string"
+ "description": "true if operation is executed successfully",
+ "name": "success",
+ "type": "boolean"
},
{},
+ {},
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
@@ -103516,11 +105092,10 @@
"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"
+ }
]
},
{
@@ -103536,59 +105111,59 @@
"type": "string"
},
{
- "description": "Id of the Region",
- "length": 255,
- "name": "id",
- "required": true,
- "type": "integer"
- },
- {
"description": "Region service endpoint",
"length": 255,
"name": "endpoint",
"required": true,
"type": "string"
+ },
+ {
+ "description": "Id of the Region",
+ "length": 255,
+ "name": "id",
+ "required": true,
+ "type": "integer"
}
],
"related": "",
"response": [
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {},
- {},
- {
"description": "true if GSLB service is enabled in the region, false otherwise",
"name": "gslbserviceenabled",
"type": "boolean"
},
{
- "description": "the ID of the region",
- "name": "id",
- "type": "integer"
- },
- {
"description": "the end point of the region",
"name": "endpoint",
"type": "string"
},
{
+ "description": "the ID of the region",
+ "name": "id",
+ "type": "integer"
+ },
+ {
"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 UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
"description": "true if security groups support is enabled, false otherwise",
"name": "portableipserviceenabled",
"type": "boolean"
- }
+ },
+ {}
]
},
{
@@ -103597,6 +105172,13 @@
"name": "generateUsageRecords",
"params": [
{
+ "description": "End date range for usage record query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03.",
+ "length": 255,
+ "name": "enddate",
+ "required": true,
+ "type": "date"
+ },
+ {
"description": "List events for the specified domain.",
"length": 255,
"name": "domainid",
@@ -103605,13 +105187,6 @@
"type": "uuid"
},
{
- "description": "End date range for usage record query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03.",
- "length": 255,
- "name": "enddate",
- "required": true,
- "type": "date"
- },
- {
"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": "startdate",
@@ -103621,27 +105196,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": "the UUID of the latest async job acting on 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"
- },
- {}
+ }
]
},
{
@@ -103650,22 +105225,6 @@
"name": "updateRolePermission",
"params": [
{
- "description": "ID of the role",
- "length": 255,
- "name": "roleid",
- "related": "",
- "required": true,
- "type": "uuid"
- },
- {
- "description": "The parent role permission uuid, use 0 to move this rule at the top of the list",
- "length": 255,
- "name": "ruleorder",
- "related": "",
- "required": false,
- "type": "list"
- },
- {
"description": "Rule permission, can be: allow or deny",
"length": 255,
"name": "permission",
@@ -103681,6 +105240,22 @@
"required": false,
"since": "4.11",
"type": "uuid"
+ },
+ {
+ "description": "The parent role permission uuid, use 0 to move this rule at the top of the list",
+ "length": 255,
+ "name": "ruleorder",
+ "related": "",
+ "required": false,
+ "type": "list"
+ },
+ {
+ "description": "ID of the role",
+ "length": 255,
+ "name": "roleid",
+ "related": "",
+ "required": true,
+ "type": "uuid"
}
],
"response": [
@@ -103689,23 +105264,23 @@
"name": "success",
"type": "boolean"
},
+ {},
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
{
"description": "any text associated with the success or failure",
"name": "displaytext",
"type": "string"
},
- {},
- {},
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- }
+ {}
],
"since": "4.9.0"
},
@@ -103715,20 +105290,6 @@
"name": "listSSHKeyPairs",
"params": [
{
- "description": "A key pair name to look for",
- "length": 255,
- "name": "name",
- "required": false,
- "type": "string"
- },
- {
- "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
- "length": 255,
- "name": "isrecursive",
- "required": false,
- "type": "boolean"
- },
- {
"description": "list objects by project",
"length": 255,
"name": "projectid",
@@ -103737,35 +105298,6 @@
"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.",
- "length": 255,
- "name": "account",
- "required": false,
- "type": "string"
- },
- {
- "description": "A public key fingerprint to look for",
- "length": 255,
- "name": "fingerprint",
- "required": false,
- "type": "string"
- },
- {
- "description": "list only resources belonging to the domain specified",
- "length": 255,
- "name": "domainid",
- "related": "listDomains",
- "required": false,
- "type": "uuid"
- },
- {
"description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false",
"length": 255,
"name": "listall",
@@ -103773,11 +105305,19 @@
"type": "boolean"
},
{
- "description": "",
+ "description": "list only resources belonging to the domain specified",
"length": 255,
- "name": "pagesize",
+ "name": "domainid",
+ "related": "listDomains",
"required": false,
- "type": "integer"
+ "type": "uuid"
+ },
+ {
+ "description": "A public key fingerprint to look for",
+ "length": 255,
+ "name": "fingerprint",
+ "required": false,
+ "type": "string"
},
{
"description": "",
@@ -103785,36 +105325,55 @@
"name": "page",
"required": false,
"type": "integer"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "A key pair name to look for",
+ "length": 255,
+ "name": "name",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
+ "length": 255,
+ "name": "isrecursive",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "list resources by account. Must be used with the domainId parameter.",
+ "length": 255,
+ "name": "account",
+ "required": false,
+ "type": "string"
}
],
"related": "",
"response": [
{
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "ID of the ssh keypair",
- "name": "id",
+ "description": "the owner of the keypair",
+ "name": "account",
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
"description": "the domain name of the keypair owner",
"name": "domain",
"type": "string"
},
- {},
- {
- "description": "Fingerprint of the public key",
- "name": "fingerprint",
- "type": "string"
- },
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
@@ -103825,16 +105384,32 @@
"name": "domainid",
"type": "string"
},
+ {},
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "ID of the ssh keypair",
+ "name": "id",
+ "type": "string"
+ },
{
"description": "Name of the keypair",
"name": "name",
"type": "string"
},
{
- "description": "the owner of the keypair",
- "name": "account",
+ "description": "Fingerprint of the public key",
+ "name": "fingerprint",
"type": "string"
},
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
{}
]
},
@@ -103844,56 +105419,13 @@
"name": "listAccounts",
"params": [
{
- "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
+ "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false",
"length": 255,
- "name": "isrecursive",
+ "name": "listall",
"required": false,
"type": "boolean"
},
{
- "description": "list account by account ID",
- "length": 255,
- "name": "id",
- "related": "enableAccount,listAccounts,listAccounts",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "list accounts by account type. Valid account types are 1 (admin), 2 (domain-admin), and 0 (user).",
- "length": 255,
- "name": "accounttype",
- "required": false,
- "type": "long"
- },
- {
- "description": "list accounts by cleanuprequired attribute (values are true or false)",
- "length": 255,
- "name": "iscleanuprequired",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "list accounts by state. Valid states are enabled, disabled, and locked.",
- "length": 255,
- "name": "state",
- "required": false,
- "type": "string"
- },
- {
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
- },
- {
- "description": "",
- "length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
- },
- {
"description": "",
"length": 255,
"name": "pagesize",
@@ -103901,23 +105433,16 @@
"type": "integer"
},
{
- "description": "list account by account name",
+ "description": "List by keyword",
"length": 255,
- "name": "name",
+ "name": "keyword",
"required": false,
"type": "string"
},
{
- "description": "flag to display the resource icon for accounts",
+ "description": "list accounts by cleanuprequired attribute (values are true or false)",
"length": 255,
- "name": "showicon",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false",
- "length": 255,
- "name": "listall",
+ "name": "iscleanuprequired",
"required": false,
"type": "boolean"
},
@@ -103929,22 +105454,147 @@
"type": "list"
},
{
+ "description": "list accounts by account type. Valid account types are 1 (admin), 2 (domain-admin), and 0 (user).",
+ "length": 255,
+ "name": "accounttype",
+ "required": false,
+ "type": "long"
+ },
+ {
+ "description": "flag to display the resource icon for accounts",
+ "length": 255,
+ "name": "showicon",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
+ "length": 255,
+ "name": "isrecursive",
+ "required": false,
+ "type": "boolean"
+ },
+ {
"description": "list only resources belonging to the domain specified",
"length": 255,
"name": "domainid",
"related": "listDomains",
"required": false,
"type": "uuid"
+ },
+ {
+ "description": "list accounts by state. Valid states are enabled, disabled, and locked.",
+ "length": 255,
+ "name": "state",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "list account by account name",
+ "length": 255,
+ "name": "name",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "list account by account ID",
+ "length": 255,
+ "name": "id",
+ "related": "enableAccount,listAccounts,listAccounts",
+ "required": false,
+ "type": "uuid"
}
],
"related": "enableAccount,listAccounts",
"response": [
{
- "description": "the total number of public ip addresses this account can acquire",
- "name": "iplimit",
+ "description": "the total memory (in MB) owned by account",
+ "name": "memorytotal",
+ "type": "long"
+ },
+ {
+ "description": "account type (admin, domain-admin, user)",
+ "name": "accounttype",
+ "type": "short"
+ },
+ {
+ "description": "the total primary storage space (in GiB) owned by account",
+ "name": "primarystoragetotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of virtual machines available for this account to acquire",
+ "name": "vmavailable",
"type": "string"
},
{
+ "description": "the total number of snapshots stored by this account",
+ "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) the account can own",
+ "name": "memorylimit",
+ "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 network traffic bytes sent",
+ "name": "sentbytes",
+ "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 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 number of vpcs owned by account",
+ "name": "vpctotal",
+ "type": "long"
+ },
+ {
+ "description": "the name of the role",
+ "name": "rolename",
+ "type": "string"
+ },
+ {
+ "description": "true if the account requires cleanup",
+ "name": "iscleanuprequired",
+ "type": "boolean"
+ },
+ {
"description": "the default zone of the account",
"name": "defaultzoneid",
"type": "string"
@@ -103955,387 +105605,13 @@
"type": "float"
},
{
- "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 snapshots available for this account",
- "name": "snapshotavailable",
- "type": "string"
- },
- {
- "description": "the list of acl groups that account belongs to",
- "name": "groups",
- "type": "list"
- },
- {
- "description": "the total number of network traffic bytes received",
- "name": "receivedbytes",
- "type": "long"
- },
- {
- "description": "account type (admin, domain-admin, user)",
- "name": "accounttype",
- "type": "short"
- },
- {
- "description": "the total number of public ip addresses available for this account to acquire",
- "name": "ipavailable",
- "type": "string"
- },
- {
- "description": "the total memory (in MB) owned by account",
- "name": "memorytotal",
- "type": "long"
- },
- {
- "description": "the total number of snapshots stored by this account",
- "name": "snapshottotal",
- "type": "long"
- },
- {
- "description": "the total volume being used by this account",
- "name": "volumetotal",
- "type": "long"
- },
- {
- "description": "the list of users associated with account",
- "name": "user",
- "response": [
- {
- "description": "the user state",
- "name": "state",
- "type": "string"
- },
- {
- "description": "the ID of the role",
- "name": "roleid",
- "type": "string"
- },
- {
- "description": "the account name of the user",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the secret key of the user",
- "name": "secretkey",
- "type": "string"
- },
- {
- "description": "the user name",
- "name": "username",
- "type": "string"
- },
- {
- "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 timezone user was created in",
- "name": "timezone",
- "type": "string"
- },
- {
- "description": "the domain name of the user",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the user lastname",
- "name": "lastname",
- "type": "string"
- },
- {
- "description": "the account ID of the user",
- "name": "accountid",
- "type": "string"
- },
- {
- "description": "the user ID",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the domain ID of the user",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
- },
- {
- "description": "the account type of the user",
- "name": "accounttype",
- "type": "short"
- },
- {
- "description": "the api key of the user",
- "name": "apikey",
- "type": "string"
- },
- {
- "description": "true if user is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
- },
- {
- "description": "the user firstname",
- "name": "firstname",
- "type": "string"
- },
- {
- "description": "the date and time the user account was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the user email address",
- "name": "email",
- "type": "string"
- },
- {
- "description": "the type of the role",
- "name": "roletype",
- "type": "string"
- },
- {
- "description": "the name of the role",
- "name": "rolename",
- "type": "string"
- }
- ],
- "type": "list"
- },
- {
- "description": "the total primary storage space (in GiB) the account can own",
- "name": "primarystoragelimit",
- "type": "string"
- },
- {
- "description": "the total number of cpu cores the account can own",
- "name": "cpulimit",
- "type": "string"
- },
- {
- "description": "the total volume available for this account",
- "name": "volumeavailable",
- "type": "string"
- },
- {
- "description": "the total secondary storage space (in GiB) available to be used for this account",
- "name": "secondarystorageavailable",
- "type": "string"
- },
- {
- "description": "the total memory (in MB) the account can own",
- "name": "memorylimit",
- "type": "string"
- },
- {
- "description": "the total number of templates available to be created by this account",
- "name": "templateavailable",
- "type": "string"
- },
- {
- "description": "the total number of templates which have been created by this account",
- "name": "templatetotal",
- "type": "long"
- },
- {
- "description": "the total number of virtual machines running for this account",
- "name": "vmrunning",
- "type": "integer"
- },
- {
- "description": "the total number of templates which can be created by this account",
- "name": "templatelimit",
- "type": "string"
- },
- {
- "description": "the total number of cpu cores owned by account",
- "name": "cputotal",
- "type": "long"
- },
- {
- "description": "the total secondary storage space (in GiB) the account can own",
- "name": "secondarystoragelimit",
- "type": "string"
- },
- {
- "description": "the total number of virtual machines that can be deployed by this account",
- "name": "vmlimit",
- "type": "string"
- },
- {
- "description": "the id of the account",
- "name": "id",
- "type": "string"
- },
- {
- "description": "true if the account requires cleanup",
- "name": "iscleanuprequired",
- "type": "boolean"
- },
- {},
- {
- "description": "id of the Domain the account belongs to",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the total number of vpcs the account can own",
- "name": "vpclimit",
- "type": "string"
- },
- {
- "description": "name of the Domain the account belongs to",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the total number of vpcs owned by account",
- "name": "vpctotal",
- "type": "long"
- },
- {
- "description": "the total number of networks owned by account",
- "name": "networktotal",
- "type": "long"
- },
- {
- "description": "the total number of networks the account can own",
- "name": "networklimit",
- "type": "string"
- },
- {
- "description": "true if account is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
- },
- {
- "description": "the name of the role",
- "name": "rolename",
- "type": "string"
- },
- {
- "description": "the total 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 total number of snapshots which can be stored by this account",
- "name": "snapshotlimit",
- "type": "string"
- },
- {
- "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)",
- "name": "roletype",
- "type": "string"
- },
- {
- "description": "the total number of virtual machines deployed by this account",
- "name": "vmtotal",
- "type": "long"
- },
- {
- "description": "the total number of projects available for administration by this account",
- "name": "projectavailable",
- "type": "string"
- },
- {
- "description": "the total volume which can be used by this account",
- "name": "volumelimit",
- "type": "string"
- },
- {
- "description": "details for the account",
- "name": "accountdetails",
- "type": "map"
- },
- {
- "description": "the total number of network traffic bytes sent",
- "name": "sentbytes",
- "type": "long"
- },
- {
- "description": "the total number of projects being administrated by this account",
- "name": "projecttotal",
- "type": "long"
- },
- {
- "description": "the network domain",
- "name": "networkdomain",
- "type": "string"
- },
- {
- "description": "the total number of virtual machines stopped for this account",
- "name": "vmstopped",
- "type": "integer"
- },
- {
- "description": "the total number of cpu cores available to be created for this account",
- "name": "cpuavailable",
- "type": "string"
- },
- {
- "description": "the name of the account",
- "name": "name",
- "type": "string"
- },
- {
"description": "path of the Domain the account belongs to",
"name": "domainpath",
"type": "string"
},
{
- "description": "the ID of the role",
- "name": "roleid",
- "type": "string"
- },
- {
- "description": "the total number of networks available to be created for this account",
- "name": "networkavailable",
- "type": "string"
- },
- {
- "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) available to be used for this account",
- "name": "primarystorageavailable",
- "type": "string"
- },
- {},
- {
- "description": "the total memory (in MB) available to be created for this account",
- "name": "memoryavailable",
+ "description": "the total primary storage space (in GiB) the account can own",
+ "name": "primarystoragelimit",
"type": "string"
},
{
@@ -104344,8 +105620,44 @@
"type": "string"
},
{
- "description": "the total number of projects the account can own",
- "name": "projectlimit",
+ "description": "the total primary storage space (in GiB) available to be used for this account",
+ "name": "primarystorageavailable",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the role",
+ "name": "roleid",
+ "type": "string"
+ },
+ {
+ "description": "the id of the account",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "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",
+ "type": "string"
+ },
+ {
+ "description": "the total number of networks available to be created for this account",
+ "name": "networkavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of templates which have been created by this account",
+ "name": "templatetotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of virtual machines that can be deployed by this account",
+ "name": "vmlimit",
"type": "string"
},
{
@@ -104354,9 +105666,272 @@
"type": "string"
},
{
- "description": "the date when this account was created",
- "name": "created",
- "type": "date"
+ "description": "the total number of public ip addresses this account can acquire",
+ "name": "iplimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of virtual machines running for this account",
+ "name": "vmrunning",
+ "type": "integer"
+ },
+ {
+ "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": "short"
+ },
+ {
+ "description": "the user state",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "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 domain name of the user",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "true if user is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {
+ "description": "the boolean value representing if the updating target is in caller's child domain",
+ "name": "iscallerchilddomain",
+ "type": "boolean"
+ },
+ {
+ "description": "the date and time the user account was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the user firstname",
+ "name": "firstname",
+ "type": "string"
+ },
+ {
+ "description": "the secret key of the user",
+ "name": "secretkey",
+ "type": "string"
+ },
+ {
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "description": "the account ID of the user",
+ "name": "accountid",
+ "type": "string"
+ },
+ {
+ "description": "the user name",
+ "name": "username",
+ "type": "string"
+ },
+ {
+ "description": "the timezone user was created in",
+ "name": "timezone",
+ "type": "string"
+ },
+ {
+ "description": "the user ID",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the api key of the user",
+ "name": "apikey",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the role",
+ "name": "roleid",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID of the user",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the user email address",
+ "name": "email",
+ "type": "string"
+ },
+ {
+ "description": "the user lastname",
+ "name": "lastname",
+ "type": "string"
+ },
+ {
+ "description": "the account name of the user",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the type of the role",
+ "name": "roletype",
+ "type": "string"
+ }
+ ],
+ "type": "list"
+ },
+ {
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "description": "the network domain",
+ "name": "networkdomain",
+ "type": "string"
+ },
+ {
+ "description": "the total number of projects being administrated by this account",
+ "name": "projecttotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of public ip addresses available for this account to acquire",
+ "name": "ipavailable",
+ "type": "string"
+ },
+ {
+ "description": "name of the Domain the account belongs to",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the total volume which can be used by this account",
+ "name": "volumelimit",
+ "type": "string"
+ },
+ {
+ "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)",
+ "name": "roletype",
+ "type": "string"
+ },
+ {
+ "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 number of public ip addresses allocated for this account",
+ "name": "iptotal",
+ "type": "long"
+ },
+ {
+ "description": "true if account is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {
+ "description": "the total number of virtual machines stopped for this account",
+ "name": "vmstopped",
+ "type": "integer"
+ },
+ {
+ "description": "the total volume being used by this account",
+ "name": "volumetotal",
+ "type": "long"
+ },
+ {
+ "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 snapshots available for this account",
+ "name": "snapshotavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total secondary storage space (in GiB) available to be used for this account",
+ "name": "secondarystorageavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total volume available for this account",
+ "name": "volumeavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of vpcs the account can own",
+ "name": "vpclimit",
+ "type": "string"
+ },
+ {
+ "description": "the name of the account",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the total memory (in MB) available to be created for this account",
+ "name": "memoryavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of snapshots which can be stored by this account",
+ "name": "snapshotlimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of vpcs available to be created for this account",
+ "name": "vpcavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of virtual machines deployed by this account",
+ "name": "vmtotal",
+ "type": "long"
+ },
+ {
+ "description": "the list of acl groups that account belongs to",
+ "name": "groups",
+ "type": "list"
+ },
+ {
+ "description": "the total number of networks owned by account",
+ "name": "networktotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of templates available to be created by this account",
+ "name": "templateavailable",
+ "type": "string"
}
]
},
@@ -104377,34 +105952,8 @@
"related": "",
"response": [
{
- "description": "the hypervisor type of the storage pool",
- "name": "hypervisor",
- "type": "string"
- },
- {
- "description": "true if this pool is suitable to migrate a volume, false otherwise",
- "name": "suitableformigration",
- "type": "boolean"
- },
- {
- "description": "the ID of the storage pool",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the name of the storage pool",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the overprovisionfactor for the storage pool",
- "name": "overprovisionfactor",
- "type": "string"
- },
- {},
- {
- "description": "the scope of the storage pool",
- "name": "scope",
+ "description": "the Pod ID of the storage pool",
+ "name": "podid",
"type": "string"
},
{
@@ -104413,28 +105962,28 @@
"type": "string"
},
{
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "the host's currently used disk size",
- "name": "disksizeused",
- "type": "long"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the Pod name of the storage pool",
- "name": "podname",
+ "description": "the ID of the storage pool",
+ "name": "id",
"type": "string"
},
{
- "description": "Storage provider for this pool",
- "name": "provider",
+ "description": "the total disk size of the storage pool",
+ "name": "disksizetotal",
+ "type": "long"
+ },
+ {
+ "description": "the name of the cluster for the storage pool",
+ "name": "clustername",
+ "type": "string"
+ },
+ {
+ "description": "the storage pool type",
+ "name": "type",
+ "type": "string"
+ },
+ {
+ "description": "the storage pool path",
+ "name": "path",
"type": "string"
},
{
@@ -104442,9 +105991,15 @@
"name": "disksizeallocated",
"type": "long"
},
+ {},
{
- "description": "the Zone ID of the storage pool",
- "name": "zoneid",
+ "description": "the Zone name of the storage pool",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "the overprovisionfactor for the storage pool",
+ "name": "overprovisionfactor",
"type": "string"
},
{
@@ -104453,9 +106008,24 @@
"type": "string"
},
{
- "description": "the storage pool capabilities",
- "name": "storagecapabilities",
- "type": "map"
+ "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 name of the storage pool",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
{
"description": "the state of the storage pool",
@@ -104468,13 +106038,33 @@
"type": "date"
},
{
- "description": "the IP address of the storage pool",
- "name": "ipaddress",
+ "description": "the host's currently used disk size",
+ "name": "disksizeused",
+ "type": "long"
+ },
+ {
+ "description": "the Zone ID of the storage pool",
+ "name": "zoneid",
"type": "string"
},
{
- "description": "the storage pool type",
- "name": "type",
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the scope of the storage pool",
+ "name": "scope",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the IP address of the storage pool",
+ "name": "ipaddress",
"type": "string"
},
{
@@ -104483,40 +106073,25 @@
"type": "long"
},
{
- "description": "the Pod ID of the storage pool",
- "name": "podid",
+ "description": "true if this pool is suitable to migrate a volume, false otherwise",
+ "name": "suitableformigration",
+ "type": "boolean"
+ },
+ {
+ "description": "the Pod name of the storage pool",
+ "name": "podname",
+ "type": "string"
+ },
+ {
+ "description": "the hypervisor type of the storage pool",
+ "name": "hypervisor",
"type": "string"
},
{},
{
- "description": "the name of the cluster for the storage pool",
- "name": "clustername",
- "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": "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 UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
+ "description": "the storage pool capabilities",
+ "name": "storagecapabilities",
+ "type": "map"
}
]
},
@@ -104537,44 +106112,9 @@
"related": "",
"response": [
{
- "description": "the Zone ID for the router",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the project name of the address",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the gateway for the router",
- "name": "gateway",
- "type": "string"
- },
- {
- "description": "the name of the service offering of the virtual machine",
- "name": "serviceofferingname",
- "type": "string"
- },
- {
- "description": "the domain ID associated with the router",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the ID of the corresponding public network",
- "name": "publicnetworkid",
- "type": "string"
- },
- {
- "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 state of the router",
+ "name": "state",
+ "type": "state"
},
{
"description": "the template name for the router",
@@ -104582,261 +106122,18 @@
"type": "string"
},
{
- "description": "the list of nics associated with the router",
- "name": "nic",
- "response": [
- {
- "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 gateway of the nic",
- "name": "gateway",
- "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": "Id of the NSX Logical Switch Port (if NSX based), null otherwise",
- "name": "nsxlogicalswitchport",
- "type": "string"
- },
- {
- "description": "the name of the corresponding network",
- "name": "networkname",
- "type": "string"
- },
- {
- "description": "the 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 ID of the nic",
- "name": "id",
- "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": "Type of adapter if available",
- "name": "adaptertype",
- "type": "string"
- },
- {
- "description": "the traffic type of the nic",
- "name": "traffictype",
- "type": "string"
- },
- {
- "description": "ID of the VLAN/VNI if available",
- "name": "vlanid",
- "type": "integer"
- },
- {
- "description": "the gateway of IPv6 network",
- "name": "ip6gateway",
- "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": "IP addresses associated with NIC found for unmanaged VM",
- "name": "ipaddresses",
- "type": "list"
- },
- {
- "description": "Id of the vm to which the nic belongs",
- "name": "virtualmachineid",
- "type": "string"
- },
- {
- "description": "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 broadcast uri of the nic",
- "name": "broadcasturi",
- "type": "string"
- },
- {
- "description": "the IPv6 address of network",
- "name": "ip6address",
- "type": "string"
- },
- {
- "description": "the Secondary ipv4 addr of nic",
- "name": "secondaryip",
- "type": "list"
- }
- ],
- "type": "set"
- },
- {
- "description": "the name of the router",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the guest MAC address for the router",
- "name": "guestmacaddress",
- "type": "string"
- },
- {
- "description": "the version of scripts",
- "name": "scriptsversion",
- "type": "string"
- },
- {
- "description": "the guest IP address for the router",
- "name": "guestipaddress",
- "type": "string"
- },
- {
- "description": "the first IPv6 DNS for the router",
- "name": "ip6dns1",
- "type": "string"
- },
- {
- "description": "true if the router template requires upgrader",
- "name": "requiresupgrade",
- "type": "boolean"
- },
- {
- "description": "the Zone name for the router",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "role of the domain router",
- "name": "role",
- "type": "string"
- },
- {
- "description": "the id of the router",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the host ID for the router",
- "name": "hostid",
- "type": "string"
- },
- {
"description": "the domain associated with the router",
"name": "domain",
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "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 Pod name for the router",
- "name": "podname",
- "type": "string"
- },
- {
- "description": "the first DNS for the router",
- "name": "dns1",
- "type": "string"
- },
- {
- "description": "the public MAC address for the router",
- "name": "publicmacaddress",
- "type": "string"
- },
- {
- "description": "VPC the router belongs to",
- "name": "vpcid",
- "type": "string"
- },
- {
- "description": "the version of template",
- "name": "version",
- "type": "string"
- },
- {
- "description": "the second DNS for the router",
- "name": "dns2",
- "type": "string"
- },
- {},
- {
- "description": "if this router is an redundant virtual router",
- "name": "isredundantrouter",
- "type": "boolean"
- },
- {
- "description": "the link local MAC address for the router",
- "name": "linklocalmacaddress",
- "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 name of VPC the router belongs to",
+ "name": "vpcname",
"type": "string"
},
{
@@ -104845,8 +106142,23 @@
"type": "string"
},
{
- "description": "the link local IP address for the router",
- "name": "linklocalip",
+ "description": "the first IPv6 DNS for the router",
+ "name": "ip6dns1",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the first DNS for the router",
+ "name": "dns1",
+ "type": "string"
+ },
+ {
+ "description": "the network domain for the router",
+ "name": "networkdomain",
"type": "string"
},
{
@@ -104855,19 +106167,63 @@
"type": "string"
},
{
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the guest MAC address for the router",
+ "name": "guestmacaddress",
+ "type": "string"
+ },
+ {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
- {},
{
"description": "the public netmask for the router",
"name": "publicnetmask",
"type": "string"
},
{
- "description": "the project id of the ipaddress",
- "name": "projectid",
+ "description": "if this router is an redundant virtual router",
+ "name": "isredundantrouter",
+ "type": "boolean"
+ },
+ {
+ "description": "the hostname for the router",
+ "name": "hostname",
+ "type": "string"
+ },
+ {
+ "description": "the name of the service offering of the virtual machine",
+ "name": "serviceofferingname",
+ "type": "string"
+ },
+ {
+ "description": "the link local IP address for the router",
+ "name": "linklocalip",
+ "type": "string"
+ },
+ {
+ "description": "true if the router template requires upgrader",
+ "name": "requiresupgrade",
+ "type": "boolean"
+ },
+ {
+ "description": "the public MAC address for the router",
+ "name": "publicmacaddress",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the service offering of the virtual machine",
+ "name": "serviceofferingid",
+ "type": "string"
+ },
+ {
+ "description": "VPC the router belongs to",
+ "name": "vpcid",
"type": "string"
},
{
@@ -104880,11 +106236,6 @@
"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"
@@ -104898,53 +106249,170 @@
"description": "the date this VPC was created",
"name": "lastupdated",
"type": "date"
+ },
+ {
+ "description": "the name of the health check on the router",
+ "name": "checkname",
+ "type": "string"
}
],
"type": "list"
},
{
- "description": "the 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 link local netmask for the router",
"name": "linklocalnetmask",
"type": "string"
},
{
- "description": "the ID of the corresponding link local network",
- "name": "linklocalnetworkid",
- "type": "string"
- },
- {
"description": "the Pod ID for the router",
"name": "podid",
"type": "string"
},
{
- "description": "the hostname for the router",
- "name": "hostname",
+ "description": "the list of nics associated with the router",
+ "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": "the name of the corresponding network",
+ "name": "networkname",
+ "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": "the ID of the corresponding network",
+ "name": "networkid",
+ "type": "string"
+ },
+ {
+ "description": "the broadcast uri of the nic",
+ "name": "broadcasturi",
+ "type": "string"
+ },
+ {
+ "description": "true if nic is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {
+ "description": "the gateway of IPv6 network",
+ "name": "ip6gateway",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the nic",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "IP addresses associated with NIC found for unmanaged VM",
+ "name": "ipaddresses",
+ "type": "list"
+ },
+ {
+ "description": "the type of the nic",
+ "name": "type",
+ "type": "string"
+ },
+ {
+ "description": "the extra dhcp options on the nic",
+ "name": "extradhcpoption",
+ "type": "list"
+ },
+ {
+ "description": "the isolation uri of the nic",
+ "name": "isolationuri",
+ "type": "string"
+ },
+ {
+ "description": "the isolated private VLAN if available",
+ "name": "isolatedpvlan",
+ "type": "integer"
+ },
+ {
+ "description": "the gateway of the nic",
+ "name": "gateway",
+ "type": "string"
+ },
+ {
+ "description": "device id for the network when plugged into the virtual machine",
+ "name": "deviceid",
+ "type": "string"
+ },
+ {
+ "description": "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": "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": "the ip address of the nic",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "the traffic type of the nic",
+ "name": "traffictype",
+ "type": "string"
+ },
+ {
+ "description": "the cidr of IPv6 network",
+ "name": "ip6cidr",
+ "type": "string"
+ },
+ {
+ "description": "the netmask of the nic",
+ "name": "netmask",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the name of the router",
+ "name": "name",
"type": "string"
},
{
- "description": "the template ID for the router",
- "name": "templateid",
- "type": "string"
- },
- {
- "description": "the state of the router",
- "name": "state",
- "type": "state"
- },
- {
- "description": "the second IPv6 DNS for the router",
- "name": "ip6dns2",
+ "description": "the Zone name for the router",
+ "name": "zonename",
"type": "string"
},
{
@@ -104952,15 +106420,122 @@
"name": "guestnetworkid",
"type": "string"
},
+ {},
+ {
+ "description": "true if any health checks had failed",
+ "name": "healthchecksfailed",
+ "type": "boolean"
+ },
+ {
+ "description": "the version of template",
+ "name": "version",
+ "type": "string"
+ },
+ {
+ "description": "role of the domain router",
+ "name": "role",
+ "type": "string"
+ },
+ {
+ "description": "the second IPv6 DNS for the router",
+ "name": "ip6dns2",
+ "type": "string"
+ },
{
"description": "the account associated with the router",
"name": "account",
"type": "string"
},
{
+ "description": "the version of scripts",
+ "name": "scriptsversion",
+ "type": "string"
+ },
+ {
+ "description": "the host ID for the router",
+ "name": "hostid",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID associated with the router",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the project id of the ipaddress",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the Zone ID for the router",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the id of the router",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the template ID for the router",
+ "name": "templateid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the link local MAC address for the router",
+ "name": "linklocalmacaddress",
+ "type": "string"
+ },
+ {
"description": "the state of redundant virtual router",
"name": "redundantstate",
"type": "string"
+ },
+ {
+ "description": "the hypervisor on which the template runs",
+ "name": "hypervisor",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the corresponding public network",
+ "name": "publicnetworkid",
+ "type": "string"
+ },
+ {
+ "description": "the public IP address for the router",
+ "name": "publicip",
+ "type": "string"
+ },
+ {
+ "description": "the guest IP address for the router",
+ "name": "guestipaddress",
+ "type": "string"
+ },
+ {
+ "description": "the gateway for the router",
+ "name": "gateway",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the corresponding link local network",
+ "name": "linklocalnetworkid",
+ "type": "string"
+ },
+ {
+ "description": "the second DNS for the router",
+ "name": "dns2",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the address",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the Pod name for the router",
+ "name": "podname",
+ "type": "string"
}
]
},
@@ -104970,14 +106545,6 @@
"name": "updateSnapshotPolicy",
"params": [
{
- "description": "an optional field, whether to the display the snapshot policy to the end user or not.",
- "length": 255,
- "name": "fordisplay",
- "required": false,
- "since": "4.4",
- "type": "boolean"
- },
- {
"description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only",
"length": 255,
"name": "customid",
@@ -104992,58 +106559,51 @@
"related": "updateSnapshotPolicy",
"required": false,
"type": "uuid"
+ },
+ {
+ "description": "an optional field, whether to the display the snapshot policy to the end user or not.",
+ "length": 255,
+ "name": "fordisplay",
+ "required": false,
+ "since": "4.4",
+ "type": "boolean"
}
],
"related": "",
"response": [
{
- "description": "the ID of the snapshot policy",
- "name": "id",
+ "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": "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": "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",
+ "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 domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
"type": "string"
},
{
@@ -105052,8 +106612,18 @@
"type": "string"
},
{
- "description": "id of the resource",
- "name": "resourceid",
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
"type": "string"
},
{
@@ -105062,38 +106632,43 @@
"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": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
"type": "string"
}
],
"type": "set"
},
+ {
+ "description": "time the snapshot is scheduled to be taken.",
+ "name": "schedule",
+ "type": "string"
+ },
{},
{
- "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": "maximum number of snapshots retained",
"name": "maxsnaps",
"type": "int"
},
{
- "description": "the interval type of the snapshot policy",
- "name": "intervaltype",
- "type": "short"
+ "description": "is this policy for display to the regular user",
+ "name": "fordisplay",
+ "type": "boolean"
+ },
+ {
+ "description": "the time zone of the snapshot policy",
+ "name": "timezone",
+ "type": "string"
},
{
"description": "the current status of the latest async job acting on this object",
@@ -105101,9 +106676,9 @@
"type": "integer"
},
{
- "description": "is this policy for display to the regular user",
- "name": "fordisplay",
- "type": "boolean"
+ "description": "the ID of the snapshot policy",
+ "name": "id",
+ "type": "string"
}
]
},
@@ -105124,55 +106699,39 @@
"related": "",
"response": [
{
- "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 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 unique ID of the instance/entity object related to the job",
- "name": "jobinstanceid",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
- "description": "the result type",
- "name": "jobresulttype",
- "type": "string"
- },
- {
- "description": "the progress information of the PENDING job",
- "name": "jobprocstatus",
- "type": "integer"
- },
- {
- "description": "the instance/entity object related to the job",
- "name": "jobinstancetype",
- "type": "string"
- },
- {},
- {
"description": " the created date of the job",
"name": "created",
"type": "date"
},
{
- "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 result reason",
+ "name": "jobresult",
+ "type": "responseobject"
+ },
+ {
+ "description": "the progress information of the PENDING job",
+ "name": "jobprocstatus",
+ "type": "integer"
+ },
+ {},
+ {
+ "description": "the user that executed the async command",
+ "name": "userid",
"type": "string"
},
{
@@ -105181,16 +106740,32 @@
"type": "integer"
},
{
+ "description": "the result type",
+ "name": "jobresulttype",
+ "type": "string"
+ },
+ {
"description": "the current job status-should be 0 for PENDING",
"name": "jobstatus",
"type": "integer"
},
+ {},
+ {
+ "description": " the completed date of the job",
+ "name": "completed",
+ "type": "date"
+ },
{
"description": "the account that executed the async command",
"name": "accountid",
"type": "string"
},
{
+ "description": "the instance/entity object related to the job",
+ "name": "jobinstancetype",
+ "type": "string"
+ },
+ {
"description": "the async command executed",
"name": "cmd",
"type": "string"
@@ -105203,13 +106778,6 @@
"name": "registerNetscalerControlCenter",
"params": [
{
- "description": "Credentials to reach netscaler controlcenter device",
- "length": 255,
- "name": "username",
- "required": true,
- "type": "string"
- },
- {
"description": "URL of the netscaler controlcenter appliance.",
"length": 255,
"name": "ipaddress",
@@ -105217,9 +106785,9 @@
"type": "string"
},
{
- "description": "Credentials to reach netscaler controlcenter device",
+ "description": "Credentials to reach netscaler controlcenter device",
"length": 255,
- "name": "password",
+ "name": "username",
"required": true,
"type": "string"
},
@@ -105229,34 +106797,37 @@
"name": "numretries",
"required": true,
"type": "integer"
+ },
+ {
+ "description": "Credentials to reach netscaler controlcenter device",
+ "length": 255,
+ "name": "password",
+ "required": true,
+ "type": "string"
}
],
"related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers",
"response": [
{
- "description": "public IP of the NetScaler representing GSLB site",
- "name": "gslbproviderpublicip",
+ "description": "device name",
+ "name": "lbdevicename",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the management IP address of the external load balancer",
+ "name": "ipaddress",
"type": "string"
},
{
- "description": "device id of the netscaler load balancer",
- "name": "lbdeviceid",
+ "description": "private IP of the NetScaler representing GSLB site",
+ "name": "gslbproviderprivateip",
"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": "device capacity",
+ "name": "lbdevicecapacity",
+ "type": "long"
},
{
"description": "device state",
@@ -105264,13 +106835,13 @@
"type": "string"
},
{
- "description": "the physical network to which this netscaler device belongs to",
- "name": "physicalnetworkid",
- "type": "string"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
{
- "description": "the private interface of the load balancer",
- "name": "privateinterface",
+ "description": "name of the provider",
+ "name": "provider",
"type": "string"
},
{
@@ -105279,34 +106850,39 @@
"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": "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": "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": "true if NetScaler device is provisioned exclusively to be a GSLB service provider",
+ "name": "isexclusivegslbprovider",
+ "type": "boolean"
},
{
- "description": "device capacity",
- "name": "lbdevicecapacity",
- "type": "long"
- },
- {
- "description": "the management IP address of the external load balancer",
- "name": "ipaddress",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
- "description": "name of the provider",
- "name": "provider",
+ "description": "the physical network to which this netscaler device belongs to",
+ "name": "physicalnetworkid",
"type": "string"
},
{
@@ -105315,11 +106891,10 @@
"type": "boolean"
},
{
- "description": "device name",
- "name": "lbdevicename",
+ "description": "public IP of the NetScaler representing GSLB site",
+ "name": "gslbproviderpublicip",
"type": "string"
- },
- {}
+ }
]
},
{
@@ -105328,13 +106903,18 @@
"name": "listImageStores",
"params": [
{
- "description": "read-only status of the image store",
+ "description": "",
"length": 255,
- "name": "readonly",
- "related": "listImageStores",
+ "name": "page",
"required": false,
- "since": "4.15.0",
- "type": "boolean"
+ "type": "integer"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
},
{
"description": "List by keyword",
@@ -105344,6 +106924,35 @@
"type": "string"
},
{
+ "description": "the image store provider",
+ "length": 255,
+ "name": "provider",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the ID of the storage pool",
+ "length": 255,
+ "name": "id",
+ "related": "listImageStores",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "the name of the image store",
+ "length": 255,
+ "name": "name",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the image store protocol",
+ "length": 255,
+ "name": "protocol",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "the Zone ID for the image store",
"length": 255,
"name": "zoneid",
@@ -105352,55 +106961,21 @@
"type": "uuid"
},
{
- "description": "the image store protocol",
+ "description": "read-only status of the image store",
"length": 255,
- "name": "protocol",
- "required": false,
- "type": "string"
- },
- {
- "description": "the name of the image store",
- "length": 255,
- "name": "name",
- "required": false,
- "type": "string"
- },
- {
- "description": "the image store provider",
- "length": 255,
- "name": "provider",
- "required": false,
- "type": "string"
- },
- {
- "description": "",
- "length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
- },
- {
- "description": "",
- "length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
- },
- {
- "description": "the ID of the storage pool",
- "length": 255,
- "name": "id",
+ "name": "readonly",
"related": "listImageStores",
"required": false,
- "type": "uuid"
+ "since": "4.15.0",
+ "type": "boolean"
}
],
"related": "",
"response": [
{
- "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 protocol of the image store",
@@ -105408,32 +106983,41 @@
"type": "string"
},
{
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
"description": "the url of the image store",
"name": "url",
"type": "string"
},
- {},
{
"description": "defines if store is read-only",
"name": "readonly",
"type": "boolean"
},
{
+ "description": "the name of the image store",
+ "name": "name",
+ "type": "string"
+ },
+ {
"description": "the Zone ID of the image store",
"name": "zoneid",
"type": "string"
},
{
- "description": "the provider name of the image store",
- "name": "providername",
+ "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": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
"description": "the host's currently used disk size",
"name": "disksizeused",
"type": "long"
@@ -105443,20 +107027,11 @@
"name": "disksizetotal",
"type": "long"
},
- {
- "description": "the name of the image store",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the ID of the image store",
- "name": "id",
- "type": "string"
- },
+ {},
{},
{
- "description": "the Zone name of the image store",
- "name": "zonename",
+ "description": "the provider name of the image store",
+ "name": "providername",
"type": "string"
},
{
@@ -105493,16 +107068,16 @@
"type": "string"
},
{
- "description": "true if operation is executed successfully",
- "name": "success",
- "type": "boolean"
- },
- {},
- {
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
+ {},
+ {
+ "description": "true if operation is executed successfully",
+ "name": "success",
+ "type": "boolean"
+ },
{
"description": "any text associated with the success or failure",
"name": "displaytext",
@@ -105517,13 +107092,6 @@
"name": "createCounter",
"params": [
{
- "description": "Value of the counter e.g. oid in case of snmp.",
- "length": 255,
- "name": "value",
- "required": true,
- "type": "string"
- },
- {
"description": "Source of the counter.",
"length": 255,
"name": "source",
@@ -105536,18 +107104,20 @@
"name": "name",
"required": true,
"type": "string"
+ },
+ {
+ "description": "Value of the counter e.g. oid in case of snmp.",
+ "length": 255,
+ "name": "value",
+ "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 id of the Counter",
- "name": "id",
+ "description": "Source of the counter.",
+ "name": "source",
"type": "string"
},
{
@@ -105555,28 +107125,33 @@
"name": "jobid",
"type": "string"
},
- {},
{
"description": "Value in case of snmp or other specific counters.",
"name": "value",
"type": "string"
},
{
+ "description": "the id of the Counter",
+ "name": "id",
+ "type": "string"
+ },
+ {},
+ {
"description": "Name of the counter.",
"name": "name",
"type": "string"
},
{
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {},
+ {
"description": "zone id of counter",
"name": "zoneid",
"type": "string"
- },
- {
- "description": "Source of the counter.",
- "name": "source",
- "type": "string"
- },
- {}
+ }
]
},
{
@@ -105586,13 +107161,6 @@
"params": [],
"related": "",
"response": [
- {},
- {
- "description": "Event Type",
- "name": "name",
- "type": "string"
- },
- {},
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
@@ -105602,7 +107170,14 @@
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
- }
+ },
+ {},
+ {
+ "description": "Event Type",
+ "name": "name",
+ "type": "string"
+ },
+ {}
]
},
{
@@ -105622,26 +107197,41 @@
"related": "",
"response": [
{
+ "description": "the out-of-band management interface port",
+ "name": "port",
+ "type": "string"
+ },
+ {
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
{
- "description": "the out-of-band management interface powerState of the host",
- "name": "powerstate",
- "type": "powerstate"
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
},
{},
{
- "description": "the operation result",
- "name": "status",
- "type": "boolean"
+ "description": "the out-of-band management driver for the host",
+ "name": "driver",
+ "type": "string"
},
{
"description": "the operation result description",
"name": "description",
"type": "string"
},
+ {
+ "description": "the out-of-band management action (if issued)",
+ "name": "action",
+ "type": "string"
+ },
+ {
+ "description": "true if out-of-band management is enabled for the host",
+ "name": "enabled",
+ "type": "boolean"
+ },
{},
{
"description": "the ID of the host",
@@ -105649,23 +107239,18 @@
"type": "string"
},
{
- "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 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",
+ "description": "the operation result",
+ "name": "status",
"type": "boolean"
},
{
- "description": "the out-of-band management action (if issued)",
- "name": "action",
+ "description": "the out-of-band management interface address",
+ "name": "address",
"type": "string"
},
{
@@ -105674,19 +107259,9 @@
"type": "string"
},
{
- "description": "the out-of-band management interface port",
- "name": "port",
- "type": "string"
- },
- {
"description": "the out-of-band management interface username",
"name": "username",
"type": "string"
- },
- {
- "description": "the out-of-band management interface address",
- "name": "address",
- "type": "string"
}
],
"since": "4.9.0"
@@ -105697,31 +107272,37 @@
"name": "addCluster",
"params": [
{
- "description": "the password for the VSM associated with this cluster",
+ "description": "the username for the cluster",
"length": 255,
- "name": "vsmpassword",
+ "name": "username",
"required": false,
"type": "string"
},
{
- "description": "type of the cluster: CloudManaged, ExternalManaged",
+ "description": "the cluster name",
"length": 255,
- "name": "clustertype",
+ "name": "clustername",
"required": true,
"type": "string"
},
{
- "description": "the Pod ID for the host",
+ "description": "hypervisor type of the cluster: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator,Ovm3",
"length": 255,
- "name": "podid",
- "related": "createManagementNetworkIpRange",
+ "name": "hypervisor",
"required": true,
- "type": "uuid"
+ "type": "string"
},
{
- "description": "Name of virtual switch used for public traffic in the cluster. This would override zone wide traffic label setting.",
+ "description": "Type of virtual switch used for guest traffic in the cluster. Allowed values are, vmwaresvs (for VMware standard vSwitch) and vmwaredvs (for VMware distributed vSwitch)",
"length": 255,
- "name": "publicvswitchname",
+ "name": "guestvswitchtype",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the password for the host",
+ "length": 255,
+ "name": "password",
"required": false,
"type": "string"
},
@@ -105734,20 +107315,6 @@
"type": "uuid"
},
{
- "description": "Type of virtual switch used for public traffic in the cluster. Allowed values are, vmwaresvs (for VMware standard vSwitch) and vmwaredvs (for VMware distributed vSwitch)",
- "length": 255,
- "name": "publicvswitchtype",
- "required": false,
- "type": "string"
- },
- {
- "description": "the ipaddress of the VSM associated with this cluster",
- "length": 255,
- "name": "vsmipaddress",
- "required": false,
- "type": "string"
- },
- {
"description": "Ovm3 native OCFS2 clustering enabled for cluster",
"length": 255,
"name": "ovm3cluster",
@@ -105755,55 +107322,6 @@
"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)",
- "length": 255,
- "name": "guestvswitchtype",
- "required": false,
- "type": "string"
- },
- {
- "description": "Ovm3 vip to use for pool (and cluster)",
- "length": 255,
- "name": "ovm3vip",
- "required": false,
- "type": "string"
- },
- {
- "description": "the username for the cluster",
- "length": 255,
- "name": "username",
- "required": false,
- "type": "string"
- },
- {
- "description": "the password for the host",
- "length": 255,
- "name": "password",
- "required": false,
- "type": "string"
- },
- {
- "description": "hypervisor type of the cluster: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator,Ovm3",
- "length": 255,
- "name": "hypervisor",
- "required": true,
- "type": "string"
- },
- {
- "description": "the URL",
- "length": 255,
- "name": "url",
- "required": false,
- "type": "string"
- },
- {
- "description": "the cluster name",
- "length": 255,
- "name": "clustername",
- "required": true,
- "type": "string"
- },
- {
"description": "Allocation state of this cluster for allocation of new resources",
"length": 255,
"name": "allocationstate",
@@ -105811,6 +107329,20 @@
"type": "string"
},
{
+ "description": "Name of virtual switch used for public traffic in the cluster. This would override zone wide traffic label setting.",
+ "length": 255,
+ "name": "publicvswitchname",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the username for the VSM associated with this cluster",
+ "length": 255,
+ "name": "vsmusername",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "Name of virtual switch used for guest traffic in the cluster. This would override zone wide traffic label setting.",
"length": 255,
"name": "guestvswitchname",
@@ -105818,16 +107350,59 @@
"type": "string"
},
{
- "description": "Ovm3 native pooling enabled for cluster",
+ "description": "the URL",
"length": 255,
- "name": "ovm3pool",
+ "name": "url",
"required": false,
"type": "string"
},
{
- "description": "the username for the VSM associated with this cluster",
+ "description": "Type of virtual switch used for public traffic in the cluster. Allowed values are, vmwaresvs (for VMware standard vSwitch) and vmwaredvs (for VMware distributed vSwitch)",
"length": 255,
- "name": "vsmusername",
+ "name": "publicvswitchtype",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "type of the cluster: CloudManaged, ExternalManaged",
+ "length": 255,
+ "name": "clustertype",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "the password for the VSM associated with this cluster",
+ "length": 255,
+ "name": "vsmpassword",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the ipaddress of the VSM associated with this cluster",
+ "length": 255,
+ "name": "vsmipaddress",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "Ovm3 vip to use for pool (and cluster)",
+ "length": 255,
+ "name": "ovm3vip",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the Pod ID for the host",
+ "length": 255,
+ "name": "podid",
+ "related": "createManagementNetworkIpRange",
+ "required": true,
+ "type": "uuid"
+ },
+ {
+ "description": "Ovm3 native pooling enabled for cluster",
+ "length": 255,
+ "name": "ovm3pool",
"required": false,
"type": "string"
}
@@ -105835,78 +107410,25 @@
"related": "",
"response": [
{
- "description": "the Zone ID of the cluster",
- "name": "zoneid",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
+ {},
+ {},
{
- "description": "whether this cluster is managed by cloudstack",
- "name": "managedstate",
+ "description": "the hypervisor type of the cluster",
+ "name": "hypervisortype",
"type": "string"
},
{
- "description": "The cpu overcommit ratio of the cluster",
- "name": "cpuovercommitratio",
- "type": "string"
- },
- {
- "description": "the Pod ID of the cluster",
- "name": "podid",
- "type": "string"
- },
- {
- "description": "the cluster ID",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the Zone name of the cluster",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "the Pod name of the cluster",
- "name": "podname",
- "type": "string"
- },
- {
- "description": "the cluster name",
- "name": "name",
- "type": "string"
- },
- {
- "description": "Ovm3 VIP to use for pooling and/or clustering",
- "name": "ovm3vip",
- "type": "string"
- },
- {
- "description": "the type of the cluster",
- "name": "clustertype",
- "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": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
"description": "the capacity of the Cluster",
"name": "capacity",
"response": [
{
- "description": "the Cluster name",
- "name": "clustername",
- "type": "string"
+ "description": "the total capacity available",
+ "name": "capacitytotal",
+ "type": "long"
},
{
"description": "the capacity type",
@@ -105914,16 +107436,16 @@
"type": "short"
},
{
- "description": "the Pod ID",
- "name": "podid",
- "type": "string"
- },
- {
"description": "the capacity currently in use",
"name": "capacityused",
"type": "long"
},
{
+ "description": "the Cluster name",
+ "name": "clustername",
+ "type": "string"
+ },
+ {
"description": "the percentage of capacity currently in use",
"name": "percentused",
"type": "string"
@@ -105934,21 +107456,6 @@
"type": "string"
},
{
- "description": "the Pod name",
- "name": "podname",
- "type": "string"
- },
- {
- "description": "the capacity currently in allocated",
- "name": "capacityallocated",
- "type": "long"
- },
- {
- "description": "the total capacity available",
- "name": "capacitytotal",
- "type": "long"
- },
- {
"description": "the Cluster ID",
"name": "clusterid",
"type": "string"
@@ -105962,30 +107469,98 @@
"description": "the Zone name",
"name": "zonename",
"type": "string"
+ },
+ {
+ "description": "the Pod ID",
+ "name": "podid",
+ "type": "string"
+ },
+ {
+ "description": "the Pod name",
+ "name": "podname",
+ "type": "string"
+ },
+ {
+ "description": "the capacity currently in allocated",
+ "name": "capacityallocated",
+ "type": "long"
}
],
"type": "list"
},
{
+ "description": "the type of the cluster",
+ "name": "clustertype",
+ "type": "string"
+ },
+ {
+ "description": "the Zone name of the cluster",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "Ovm3 VIP to use for pooling and/or clustering",
+ "name": "ovm3vip",
+ "type": "string"
+ },
+ {
+ "description": "the cluster name",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "Meta data associated with the zone (key/value pairs)",
+ "name": "resourcedetails",
+ "type": "map"
+ },
+ {
+ "description": "the Pod ID of the cluster",
+ "name": "podid",
+ "type": "string"
+ },
+ {
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
- {},
{
- "description": "Meta data associated with the zone (key/value pairs)",
- "name": "resourcedetails",
- "type": "map"
- },
- {},
- {
- "description": "the hypervisor type of the cluster",
- "name": "hypervisortype",
+ "description": "the Zone ID of the cluster",
+ "name": "zoneid",
"type": "string"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "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 cluster ID",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "whether this cluster is managed by cloudstack",
+ "name": "managedstate",
+ "type": "string"
+ },
+ {
+ "description": "The cpu overcommit ratio of the cluster",
+ "name": "cpuovercommitratio",
+ "type": "string"
+ },
+ {
+ "description": "The memory overcommit ratio of the cluster",
+ "name": "memoryovercommitratio",
+ "type": "string"
+ },
+ {
+ "description": "the Pod name of the cluster",
+ "name": "podname",
"type": "string"
}
]
@@ -106006,26 +107581,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": "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"
}
]
},
@@ -106054,197 +107629,197 @@
"related": "destroyVirtualMachine,scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines",
"response": [
{
- "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.",
- "name": "isdynamicallyscalable",
+ "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": "an optional field whether to the display the vm to the end user or not.",
- "name": "displayvm",
- "type": "boolean"
- },
- {
- "description": "the project id of the vm",
- "name": "projectid",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
- "description": "the name of the template for the virtual machine",
- "name": "templatename",
+ "description": "the ID of the host for the virtual machine",
+ "name": "hostid",
"type": "string"
},
{
- "description": "user generated name. The name of the virtual machine is returned if no displayname exists.",
- "name": "displayname",
+ "description": "the vgpu type used by the virtual machine",
+ "name": "vgpu",
"type": "string"
},
{
- "description": "the list of nics associated with vm",
- "name": "nic",
- "response": [
- {
- "description": "the ID of the corresponding network",
- "name": "networkid",
- "type": "string"
- },
- {
- "description": "the netmask of the nic",
- "name": "netmask",
- "type": "string"
- },
- {
- "description": "the cidr of IPv6 network",
- "name": "ip6cidr",
- "type": "string"
- },
- {
- "description": "ID of the VLAN/VNI if available",
- "name": "vlanid",
- "type": "integer"
- },
- {
- "description": "Type of adapter if available",
- "name": "adaptertype",
- "type": "string"
- },
- {
- "description": "the extra dhcp options on the nic",
- "name": "extradhcpoption",
- "type": "list"
- },
- {
- "description": "the isolated private VLAN if available",
- "name": "isolatedpvlan",
- "type": "integer"
- },
- {
- "description": "the gateway of IPv6 network",
- "name": "ip6gateway",
- "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 gateway of the nic",
- "name": "gateway",
- "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": "true if nic is default, false otherwise",
- "name": "macaddress",
- "type": "string"
- },
- {
- "description": "the name of the corresponding network",
- "name": "networkname",
- "type": "string"
- },
- {
- "description": "true if nic is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
- },
- {
- "description": "the ID of the nic",
- "name": "id",
- "type": "string"
- },
- {
- "description": "Id of the vm to which the nic belongs",
- "name": "virtualmachineid",
- "type": "string"
- },
- {
- "description": "the isolated private VLAN type if available",
- "name": "isolatedpvlantype",
- "type": "string"
- },
- {
- "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise",
- "name": "nsxlogicalswitchport",
- "type": "string"
- },
- {
- "description": "device id for the network when plugged into the virtual machine",
- "name": "deviceid",
- "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 ip address of the nic",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "description": "the traffic type of the nic",
- "name": "traffictype",
- "type": "string"
- },
- {
- "description": "the Secondary ipv4 addr of nic",
- "name": "secondaryip",
- "type": "list"
- }
- ],
- "type": "set"
- },
- {
- "description": "Vm details in key/value pairs.",
- "name": "details",
- "type": "map"
- },
- {
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
{
- "description": "the name of the backup offering of the virtual machine",
- "name": "backupofferingname",
+ "description": "an alternate display text of the ISO attached to the virtual machine",
+ "name": "isodisplaytext",
"type": "string"
},
{
- "description": "the user's ID who deployed the virtual machine",
- "name": "userid",
+ "description": "the write (io) of disk on the vm",
+ "name": "diskiowrite",
+ "type": "long"
+ },
+ {
+ "description": "Vm details in key/value pairs.",
+ "name": "details",
+ "type": "map"
+ },
+ {
+ "description": "the target memory in vm",
+ "name": "memorytargetkbs",
+ "type": "long"
+ },
+ {
+ "description": "the user's name who deployed the virtual machine",
+ "name": "username",
"type": "string"
},
{
+ "description": "the incoming network traffic on the vm",
+ "name": "networkkbsread",
+ "type": "long"
+ },
+ {
+ "description": "user generated name. The name of the virtual machine is returned if no displayname exists.",
+ "name": "displayname",
+ "type": "string"
+ },
+ {
+ "description": "the write (bytes) of disk on the vm",
+ "name": "diskkbswrite",
+ "type": "long"
+ },
+ {
+ "description": "the name of the template for the virtual machine",
+ "name": "templatename",
+ "type": "string"
+ },
+ {
+ "description": "the hypervisor on which the template runs",
+ "name": "hypervisor",
+ "type": "string"
+ },
+ {
+ "description": "the read (io) of disk on the vm",
+ "name": "diskioread",
+ "type": "long"
+ },
+ {
+ "description": "the group name of the virtual machine",
+ "name": "group",
+ "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": "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 domain name of the affinity group",
+ "name": "domain",
+ "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": "virtual machine IDs associated with this affinity group",
+ "name": "virtualmachineIds",
+ "type": "list"
+ },
+ {
+ "description": "the account owning the affinity group",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the affinity group",
+ "name": "project",
+ "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 type of the affinity group",
+ "name": "type",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "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 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": "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"
@@ -106260,61 +107835,16 @@
"type": "string"
},
{
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
"description": "id of the resource",
"name": "resourceid",
"type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
}
],
"type": "set"
},
{
- "description": "the ID of the disk offering of the virtual machine",
- "name": "diskofferingid",
- "type": "string"
- },
- {
- "description": "OS type id of the vm",
- "name": "ostypeid",
- "type": "string"
- },
- {
- "description": "the number of cpu this virtual machine is running with",
- "name": "cpunumber",
- "type": "integer"
- },
- {
- "description": "the ID of the host for the virtual machine",
- "name": "hostid",
+ "description": "the name of the virtual machine",
+ "name": "name",
"type": "string"
},
{
@@ -106323,146 +107853,8 @@
"type": "string"
},
{
- "description": "the total number of network traffic bytes received",
- "name": "receivedbytes",
- "type": "long"
- },
- {
- "description": "OS name of the vm",
- "name": "osdisplayname",
- "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 domain in which the virtual machine exists",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the outgoing network traffic on the host",
- "name": "networkkbswrite",
- "type": "long"
- },
- {
- "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": "list of affinity groups associated with the virtual machine",
- "name": "affinitygroup",
- "response": [
- {
- "description": "the domain name of the affinity group",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the project ID of the affinity group",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the name of the affinity group",
- "name": "name",
- "type": "string"
- },
- {
- "description": "virtual machine IDs associated with this affinity group",
- "name": "virtualmachineIds",
- "type": "list"
- },
- {
- "description": "the description of the affinity group",
- "name": "description",
- "type": "string"
- },
- {
- "description": "the 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 domain ID of the affinity group",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the account owning the affinity group",
- "name": "account",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the ID of the availablility 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 vgpu type used by the virtual machine",
- "name": "vgpu",
- "type": "string"
- },
- {
- "description": "the hypervisor on which the template runs",
- "name": "hypervisor",
- "type": "string"
- },
- {
- "description": "the date when this virtual machine was updated last time",
- "name": "lastupdated",
- "type": "date"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the write (io) of disk on the vm",
- "name": "diskiowrite",
- "type": "long"
- },
- {},
- {
- "description": "the project name of the vm",
- "name": "project",
- "type": "string"
- },
- {
- "description": "List of read-only Vm details as comma separated string.",
- "name": "readonlydetails",
- "type": "string"
- },
- {
- "description": "the user's name who deployed the virtual machine",
- "name": "username",
+ "description": "the user's ID who deployed the virtual machine",
+ "name": "userid",
"type": "string"
},
{
@@ -106471,40 +107863,19 @@
"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 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": "State of the Service from LB rule",
- "name": "servicestate",
- "type": "string"
- },
- {
- "description": "the ID of the backup offering of the virtual machine",
- "name": "backupofferingid",
- "type": "string"
- },
- {},
- {
- "description": "the read (io) of disk on the vm",
- "name": "diskioread",
+ "description": "the read (bytes) of disk on the vm",
+ "name": "diskkbsread",
"type": "long"
},
{
- "description": "the date when this virtual machine was created",
- "name": "created",
- "type": "date"
+ "description": "true if high-availability is enabled, false otherwise",
+ "name": "haenable",
+ "type": "boolean"
+ },
+ {
+ "description": "the ID of the availablility zone for the virtual machine",
+ "name": "zoneid",
+ "type": "string"
},
{
"description": "device ID of the root volume",
@@ -106512,74 +107883,146 @@
"type": "long"
},
{
- "description": "the name of the ISO attached to the virtual machine",
- "name": "isoname",
+ "description": "OS name of the vm",
+ "name": "osdisplayname",
"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"
- },
- {
- "description": "the incoming network traffic on the vm",
- "name": "networkkbsread",
- "type": "long"
- },
- {
- "description": "the internal memory that's free in vm or zero if it can not be calculated",
- "name": "memoryintfreekbs",
- "type": "long"
- },
- {
- "description": "the ID of the virtual machine",
- "name": "id",
- "type": "string"
- },
- {
- "description": "Os type ID of the virtual machine",
- "name": "guestosid",
- "type": "string"
- },
- {
- "description": "the ID of the domain in which the virtual machine exists",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the pool type of the virtual machine",
- "name": "pooltype",
- "type": "string"
- },
- {
- "description": "the group name of the virtual machine",
- "name": "group",
- "type": "string"
- },
- {
- "description": "Guest vm Boot Mode",
- "name": "bootmode",
- "type": "string"
- },
- {
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "the read (bytes) of disk on the vm",
- "name": "diskkbsread",
- "type": "long"
- },
- {
- "description": "the account associated with the virtual machine",
- "name": "account",
- "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": "device id for the network when plugged into the virtual machine",
+ "name": "deviceid",
+ "type": "string"
+ },
+ {
+ "description": "IP addresses associated with NIC found for unmanaged VM",
+ "name": "ipaddresses",
+ "type": "list"
+ },
+ {
+ "description": "Id of the NSX Logical Switch (if NSX based), null otherwise",
+ "name": "nsxlogicalswitch",
+ "type": "string"
+ },
+ {
+ "description": "the gateway of IPv6 network",
+ "name": "ip6gateway",
+ "type": "string"
+ },
+ {
+ "description": "the IPv6 address of network",
+ "name": "ip6address",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the corresponding network",
+ "name": "networkid",
+ "type": "string"
+ },
+ {
+ "description": "Id of the vm to which the nic belongs",
+ "name": "virtualmachineid",
+ "type": "string"
+ },
+ {
+ "description": "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 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": "the name of the corresponding network",
+ "name": "networkname",
+ "type": "string"
+ },
+ {
+ "description": "the isolation uri of the nic",
+ "name": "isolationuri",
+ "type": "string"
+ },
+ {
+ "description": "the isolated private VLAN type if available",
+ "name": "isolatedpvlantype",
+ "type": "string"
+ },
+ {
+ "description": "the netmask of the nic",
+ "name": "netmask",
+ "type": "string"
+ },
+ {
+ "description": "the gateway of the nic",
+ "name": "gateway",
+ "type": "string"
+ },
+ {
+ "description": "the broadcast uri of the nic",
+ "name": "broadcasturi",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the nic",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "Type of adapter if available",
+ "name": "adaptertype",
+ "type": "string"
+ },
+ {
+ "description": "true if nic is default, false otherwise",
+ "name": "macaddress",
+ "type": "string"
+ },
+ {
+ "description": "the traffic type of the nic",
+ "name": "traffictype",
+ "type": "string"
+ },
+ {
+ "description": "the isolated private VLAN if available",
+ "name": "isolatedpvlan",
+ "type": "integer"
+ },
+ {
+ "description": "the Secondary ipv4 addr of nic",
+ "name": "secondaryip",
+ "type": "list"
+ },
+ {
+ "description": "the extra dhcp options on the nic",
+ "name": "extradhcpoption",
+ "type": "list"
+ }
+ ],
+ "type": "set"
},
{
"description": "Guest vm Boot Type",
@@ -106587,54 +108030,210 @@
"type": "string"
},
{
+ "description": "the project id of the vm",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the speed of each cpu",
+ "name": "cpuspeed",
+ "type": "integer"
+ },
+ {
+ "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": "the memory used by the vm",
"name": "memorykbs",
"type": "long"
},
{
- "description": "the target memory in vm",
- "name": "memorytargetkbs",
+ "description": "public IP address id associated with vm via Static nat rule",
+ "name": "publicip",
+ "type": "string"
+ },
+ {
+ "description": "OS type id of the vm",
+ "name": "ostypeid",
+ "type": "string"
+ },
+ {
+ "description": "the group ID of the virtual machine",
+ "name": "groupid",
+ "type": "string"
+ },
+ {
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "description": "the memory allocated for the virtual machine",
+ "name": "memory",
+ "type": "integer"
+ },
+ {
+ "description": "the internal memory that's free in vm or zero if it can not be calculated",
+ "name": "memoryintfreekbs",
"type": "long"
},
{
- "description": "the virtual network for the service offering",
- "name": "forvirtualnetwork",
- "type": "boolean"
- },
- {
- "description": "the name of the disk offering of the virtual machine",
- "name": "diskofferingname",
+ "description": "the name of the service offering of the virtual machine",
+ "name": "serviceofferingname",
"type": "string"
},
{
- "description": "device type of the root volume",
- "name": "rootdevicetype",
+ "description": "the name of the ISO attached to the virtual machine",
+ "name": "isoname",
"type": "string"
},
{
+ "description": "the ID of the domain in which the virtual machine exists",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the virtual machine",
+ "name": "id",
+ "type": "string"
+ },
+ {},
+ {},
+ {
"description": "the name of the host for the virtual machine",
"name": "hostname",
"type": "string"
},
{
- "description": "the total number of network traffic bytes sent",
- "name": "sentbytes",
- "type": "long"
- },
- {
"description": "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 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 list of resource tags associated with the rule",
+ "name": "tags",
+ "response": [
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ }
+ ],
+ "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 CIDR notation for the base IP address of the security group rule",
+ "name": "cidr",
+ "type": "string"
+ },
+ {
+ "description": "the ending IP of the security group rule ",
+ "name": "endport",
+ "type": "integer"
+ },
+ {
+ "description": "account owning the security group rule",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the id of the security group rule",
+ "name": "ruleid",
+ "type": "string"
+ },
+ {
+ "description": "the protocol of the security group rule",
+ "name": "protocol",
+ "type": "string"
+ },
+ {
+ "description": "security group name",
+ "name": "securitygroupname",
+ "type": "string"
+ }
+ ],
+ "type": "set"
},
{
"description": "the list of resource tags associated with the rule",
"name": "tags",
"response": [
{
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
"description": "customer associated with the tag",
"name": "customer",
"type": "string"
@@ -106645,282 +108244,69 @@
"type": "string"
},
{
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
"description": "tag 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 account associated with the tag",
- "name": "account",
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
"type": "string"
},
{
"description": "the ID of the domain associated with the tag",
"name": "domainid",
"type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the list of ingress rules associated with the security group",
- "name": "ingressrule",
- "response": [
- {
- "description": "the type of the ICMP message response",
- "name": "icmptype",
- "type": "integer"
},
{
- "description": "the protocol of the security group rule",
- "name": "protocol",
- "type": "string"
- },
- {
- "description": "the 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": "security group name",
- "name": "securitygroupname",
- "type": "string"
- },
- {
- "description": "the code for the ICMP message response",
- "name": "icmpcode",
- "type": "integer"
- },
- {
- "description": "the ending IP of the security group rule ",
- "name": "endport",
- "type": "integer"
- },
- {
- "description": "the list of resource tags associated with the rule",
- "name": "tags",
- "response": [
- {
- "description": "tag value",
- "name": "value",
- "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": "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 project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the starting IP of the security group rule",
- "name": "startport",
- "type": "integer"
- }
- ],
- "type": "set"
- },
- {
- "description": "the list of egress rules associated with the security group",
- "name": "egressrule",
- "response": [
- {
- "description": "the type of the ICMP message response",
- "name": "icmptype",
- "type": "integer"
- },
- {
- "description": "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": "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 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"
- },
- {
- "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 id of the security group rule",
- "name": "ruleid",
- "type": "string"
- },
- {
- "description": "the code for the ICMP message response",
- "name": "icmpcode",
- "type": "integer"
- },
- {
- "description": "the CIDR notation for the base IP address of the security group rule",
- "name": "cidr",
- "type": "string"
- },
- {
- "description": "the ending IP of the security group rule ",
- "name": "endport",
- "type": "integer"
- },
- {
- "description": "security group name",
- "name": "securitygroupname",
- "type": "string"
- },
- {
- "description": "the protocol of the security group rule",
- "name": "protocol",
+ "description": "the project name where tag belongs to",
+ "name": "project",
"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 domain ID of the security group",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the domain name of the security group",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the number of virtualmachines associated with this securitygroup",
+ "name": "virtualmachinecount",
+ "type": "integer"
+ },
+ {
"description": "the 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"
@@ -106936,47 +108322,210 @@
"type": "string"
},
{
- "description": "the project name of the group",
- "name": "project",
+ "description": "the project id of the group",
+ "name": "projectid",
"type": "string"
},
{
- "description": "the number of virtualmachines associated with this securitygroup",
- "name": "virtualmachinecount",
- "type": "integer"
+ "description": "the list of ingress rules associated with the security group",
+ "name": "ingressrule",
+ "response": [
+ {
+ "description": "the list of resource tags associated with the rule",
+ "name": "tags",
+ "response": [
+ {
+ "description": "the 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": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "security group name",
+ "name": "securitygroupname",
+ "type": "string"
+ },
+ {
+ "description": "account owning the security group rule",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the type of the ICMP message response",
+ "name": "icmptype",
+ "type": "integer"
+ },
+ {
+ "description": "the ending IP of the security group rule ",
+ "name": "endport",
+ "type": "integer"
+ },
+ {
+ "description": "the code for the ICMP message response",
+ "name": "icmpcode",
+ "type": "integer"
+ },
+ {
+ "description": "the id of the security group rule",
+ "name": "ruleid",
+ "type": "string"
+ },
+ {
+ "description": "the protocol of the security group rule",
+ "name": "protocol",
+ "type": "string"
+ },
+ {
+ "description": "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 domain name of the security group",
- "name": "domain",
+ "description": "the ID of the security group",
+ "name": "id",
"type": "string"
}
],
"type": "set"
},
{
- "description": "the name of the virtual machine",
- "name": "name",
+ "description": "the amount of the vm's CPU currently used",
+ "name": "cpuused",
"type": "string"
},
{
- "description": "an alternate display text of the ISO attached to the virtual machine",
- "name": "isodisplaytext",
+ "description": "device type of the root volume",
+ "name": "rootdevicetype",
"type": "string"
},
- {},
{
- "description": "the write (bytes) of disk on the vm",
- "name": "diskkbswrite",
- "type": "long"
+ "description": "the number of cpu this virtual machine is running with",
+ "name": "cpunumber",
+ "type": "integer"
},
{
- "description": "the ID of the service offering of the virtual machine",
- "name": "serviceofferingid",
+ "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 name of the disk offering of the virtual machine",
+ "name": "diskofferingname",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the virtual machine",
+ "name": "account",
"type": "string"
},
{
"description": "public IP address id associated with vm via Static nat rule",
- "name": "publicip",
+ "name": "publicipid",
+ "type": "string"
+ },
+ {
+ "description": "the date when this virtual machine was created",
+ "name": "created",
+ "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 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": "the pool type of the virtual machine",
+ "name": "pooltype",
+ "type": "string"
+ },
+ {
+ "description": "State of the Service from LB rule",
+ "name": "servicestate",
+ "type": "string"
+ },
+ {
+ "description": "the name of the backup offering of the virtual machine",
+ "name": "backupofferingname",
+ "type": "string"
+ },
+ {
+ "description": "the virtual network for the service offering",
+ "name": "forvirtualnetwork",
+ "type": "boolean"
+ },
+ {
+ "description": "List of read-only Vm details as comma separated string.",
+ "name": "readonlydetails",
"type": "string"
},
{
@@ -106985,24 +108534,50 @@
"type": "string"
},
{
- "description": "the speed of each cpu",
- "name": "cpuspeed",
- "type": "integer"
+ "description": "the total number of network traffic bytes received",
+ "name": "receivedbytes",
+ "type": "long"
},
{
- "description": "the memory allocated for the virtual machine",
- "name": "memory",
- "type": "integer"
+ "description": "the outgoing network traffic on the host",
+ "name": "networkkbswrite",
+ "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": "Os type ID of the virtual machine",
+ "name": "guestosid",
"type": "string"
+ },
+ {
+ "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",
+ "name": "diskofferingid",
+ "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"
+ },
+ {
+ "description": "Guest vm Boot Mode",
+ "name": "bootmode",
+ "type": "string"
+ },
+ {
+ "description": "the date when this virtual machine was updated last time",
+ "name": "lastupdated",
+ "type": "date"
}
]
},
@@ -107023,88 +108598,13 @@
"related": "",
"response": [
{
- "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 state of the project",
- "name": "state",
- "type": "string"
- },
- {
- "description": "the name of the project",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the id of the project",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the date this project was created",
- "name": "created",
- "type": "date"
- },
- {
"description": "the 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 public ip addresses this project can acquire",
- "name": "iplimit",
- "type": "string"
- },
- {
- "description": "the domain id the project belongs to",
- "name": "domainid",
- "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 project account name of the project",
- "name": "projectaccountname",
- "type": "string"
- },
- {
- "description": "the total number of virtual machines stopped for this project",
- "name": "vmstopped",
- "type": "integer"
- },
- {
- "description": "the total number of templates which have been created by this project",
- "name": "templatetotal",
- "type": "long"
- },
- {
- "description": "the total secondary storage space (in GiB) the project can own",
- "name": "secondarystoragelimit",
- "type": "string"
- },
- {
- "description": "the total primary storage space (in GiB) available to be used for this project",
- "name": "primarystorageavailable",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
@@ -107113,131 +108613,8 @@
"type": "long"
},
{
- "description": "the total number of vpcs owned by project",
- "name": "vpctotal",
- "type": "long"
- },
- {
- "description": "the account name of the project's owners",
- "name": "owner",
- "type": "list"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the displaytext of the project",
- "name": "displaytext",
- "type": "string"
- },
- {},
- {
- "description": "the total number of networks the project can own",
- "name": "networklimit",
- "type": "string"
- },
- {
- "description": "the list of resource tags associated with vm",
- "name": "tags",
- "response": [
- {
- "description": "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": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- }
- ],
- "type": "list"
- },
- {
- "description": "the total number of cpu cores available to be created for this project",
- "name": "cpuavailable",
- "type": "string"
- },
- {
- "description": "the total memory (in MB) owned by project",
- "name": "memorytotal",
- "type": "long"
- },
- {
- "description": "the total memory (in MB) the project can own",
- "name": "memorylimit",
- "type": "string"
- },
- {
- "description": "the total number of 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",
- "type": "long"
- },
- {
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
- },
- {
- "description": "the total number of virtual machines that can be deployed by this project",
- "name": "vmlimit",
- "type": "string"
- },
- {
- "description": "the total number of vpcs the project can own",
- "name": "vpclimit",
- "type": "string"
- },
- {
- "description": "the total number of snapshots which can be stored by this project",
- "name": "snapshotlimit",
+ "description": "the state of the project",
+ "name": "state",
"type": "string"
},
{
@@ -107246,33 +108623,74 @@
"type": "string"
},
{
+ "description": "the total number of cpu cores owned by project",
+ "name": "cputotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of networks owned by project",
+ "name": "networktotal",
+ "type": "long"
+ },
+ {
"description": "the total secondary storage space (in GiB) owned by project",
"name": "secondarystoragetotal",
"type": "float"
},
{
- "description": "the total number of snapshots available for this project",
- "name": "snapshotavailable",
+ "description": "the name of the project",
+ "name": "name",
"type": "string"
},
- {
- "description": "the domain name where the project belongs to",
- "name": "domain",
- "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 deployed by this project",
- "name": "vmtotal",
+ "description": "the domain id the project belongs to",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the account name of the project's owners",
+ "name": "owner",
+ "type": "list"
+ },
+ {
+ "description": "the total number of cpu cores available to be created for this project",
+ "name": "cpuavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total volume available for this project",
+ "name": "volumeavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of templates which have been created by this project",
+ "name": "templatetotal",
"type": "long"
},
{
- "description": "the total number of cpu cores the project can own",
- "name": "cpulimit",
+ "description": "the displaytext of the project",
+ "name": "displaytext",
+ "type": "string"
+ },
+ {
+ "description": "the total number of snapshots which can be stored by this project",
+ "name": "snapshotlimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of virtual machines stopped for this project",
+ "name": "vmstopped",
+ "type": "integer"
+ },
+ {
+ "description": "the domain name where the project belongs to",
+ "name": "domain",
"type": "string"
},
{
@@ -107281,13 +108699,94 @@
"type": "integer"
},
{
+ "description": "the total number of networks available to be created for this project",
+ "name": "networkavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of snapshots available for this project",
+ "name": "snapshotavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total primary storage space (in GiB) owned by project",
+ "name": "primarystoragetotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of templates which can be created by this project",
+ "name": "templatelimit",
+ "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 available for this project to acquire",
+ "name": "vmavailable",
+ "type": "string"
+ },
+ {
"description": "the total number of virtual machines running for this project",
"name": "vmrunning",
"type": "integer"
},
{
- "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 project account name of the project",
+ "name": "projectaccountname",
+ "type": "string"
+ },
+ {
+ "description": "the total primary storage space (in GiB) the project can own",
+ "name": "primarystoragelimit",
+ "type": "string"
+ },
+ {
+ "description": "the total volume being used by this project",
+ "name": "volumetotal",
+ "type": "long"
+ },
+ {
+ "description": "the total secondary storage space (in GiB) available to be used for this project",
+ "name": "secondarystorageavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of public ip addresses this project can acquire",
+ "name": "iplimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of virtual machines that can be deployed by this project",
+ "name": "vmlimit",
+ "type": "string"
+ },
+ {
+ "description": "the total secondary storage space (in GiB) the project can own",
+ "name": "secondarystoragelimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of public ip addresses available for this project to acquire",
+ "name": "ipavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of cpu cores the project can own",
+ "name": "cpulimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of vpcs the project can own",
+ "name": "vpclimit",
"type": "string"
},
{
@@ -107296,25 +108795,101 @@
"type": "string"
},
{
- "description": "the total number of networks owned by project",
- "name": "networktotal",
+ "description": "the total number of virtual machines deployed by this project",
+ "name": "vmtotal",
"type": "long"
},
- {},
{
- "description": "the total number of networks available to be created for this project",
- "name": "networkavailable",
+ "description": "the list of resource tags associated with vm",
+ "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 value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "the 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"
+ }
+ ],
+ "type": "list"
+ },
+ {
+ "description": "the total number of public ip addresses allocated for this project",
+ "name": "iptotal",
+ "type": "long"
+ },
+ {
+ "description": "the date this project was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the total memory (in MB) the project can own",
+ "name": "memorylimit",
"type": "string"
},
{
- "description": "the total number of templates which can be created by this project",
- "name": "templatelimit",
+ "description": "the total number of networks the project can own",
+ "name": "networklimit",
"type": "string"
},
{
- "description": "the total primary storage space (in GiB) owned by project",
- "name": "primarystoragetotal",
+ "description": "the total memory (in MB) owned by project",
+ "name": "memorytotal",
"type": "long"
+ },
+ {
+ "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"
}
],
"since": "3.0.0"
@@ -107335,26 +108910,26 @@
],
"response": [
{
+ "description": "any text associated with the success or failure",
+ "name": "displaytext",
+ "type": "string"
+ },
+ {
"description": "true if operation is executed successfully",
"name": "success",
"type": "boolean"
},
{},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {},
- {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
+ {},
{
- "description": "any text associated with the success or failure",
- "name": "displaytext",
- "type": "string"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
}
]
},
@@ -107364,10 +108939,31 @@
"name": "listDedicatedHosts",
"params": [
{
- "description": "list dedicated hosts by affinity group",
+ "description": "the name of the account associated with the host. Must be used with domainId.",
"length": 255,
- "name": "affinitygroupid",
- "related": "",
+ "name": "account",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "the ID of the domain associated with the host",
+ "length": 255,
+ "name": "domainid",
+ "related": "listDomains",
"required": false,
"type": "uuid"
},
@@ -107380,13 +108976,6 @@
"type": "uuid"
},
{
- "description": "",
- "length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
- },
- {
"description": "List by keyword",
"length": 255,
"name": "keyword",
@@ -107394,33 +108983,29 @@
"type": "string"
},
{
- "description": "the ID of the domain associated with the host",
+ "description": "list dedicated hosts by affinity group",
"length": 255,
- "name": "domainid",
- "related": "listDomains",
+ "name": "affinitygroupid",
+ "related": "",
"required": false,
"type": "uuid"
- },
- {
- "description": "",
- "length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
- },
- {
- "description": "the name of the account associated with the host. Must be used with domainId.",
- "length": 255,
- "name": "account",
- "required": false,
- "type": "string"
}
],
"related": "",
"response": [
{
- "description": "the name of the host",
- "name": "hostname",
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the Account ID of the host",
+ "name": "accountid",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{},
@@ -107430,35 +109015,25 @@
"type": "string"
},
{
- "description": "the ID of the dedicated resource",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
"description": "the Dedication Affinity Group ID of the host",
"name": "affinitygroupid",
"type": "string"
},
- {},
{
- "description": "the Account ID of the host",
- "name": "accountid",
+ "description": "the name of the host",
+ "name": "hostname",
"type": "string"
},
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
+ {},
{
"description": "the domain ID of the host",
"name": "domainid",
"type": "string"
+ },
+ {
+ "description": "the ID of the dedicated resource",
+ "name": "id",
+ "type": "string"
}
]
},
@@ -107468,35 +109043,14 @@
"name": "getUploadParamsForIso",
"params": [
{
- "description": "the ID of the zone you wish to register the ISO to.",
+ "description": "Upload volume/template 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",
- "length": 255,
- "name": "isfeatured",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true",
- "length": 255,
- "name": "bootable",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "the display text of the ISO. This is usually used for display purposes.",
- "length": 4096,
- "name": "displaytext",
- "required": true,
- "type": "string"
- },
- {
"description": "true if you want to register the ISO to be publicly available to all users, false otherwise.",
"length": 255,
"name": "ispublic",
@@ -107504,11 +109058,11 @@
"type": "boolean"
},
{
- "description": "the name of the ISO",
+ "description": "true if you want this ISO to be featured",
"length": 255,
- "name": "name",
- "required": true,
- "type": "string"
+ "name": "isfeatured",
+ "required": false,
+ "type": "boolean"
},
{
"description": "the ID of the zone the volume/template is to be hosted on",
@@ -107519,6 +109073,20 @@
"type": "uuid"
},
{
+ "description": "the display text of the ISO. This is usually used for display purposes.",
+ "length": 4096,
+ "name": "displaytext",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "the name of the ISO",
+ "length": 255,
+ "name": "name",
+ "required": true,
+ "type": "string"
+ },
+ {
"description": "an optional domainId. If the account parameter is used, domainId must also be used.",
"length": 255,
"name": "domainid",
@@ -107527,13 +109095,6 @@
"type": "uuid"
},
{
- "description": "the checksum value of this volume/template The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{<algorithm>}\", not including the double quotes. In this <algorithm> is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.",
- "length": 255,
- "name": "checksum",
- "required": false,
- "type": "string"
- },
- {
"description": "the format for the volume/template. Possible values include QCOW2, OVA, and VHD.",
"length": 255,
"name": "format",
@@ -107541,14 +109102,21 @@
"type": "string"
},
{
- "description": "the ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed",
+ "description": "the ID of the zone you wish to register the ISO to.",
"length": 255,
- "name": "ostypeid",
- "related": "",
- "required": false,
+ "name": "zoneid",
+ "related": "listZones",
+ "required": true,
"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 name of the volume/template",
"length": 255,
"name": "name",
@@ -107556,9 +109124,16 @@
"type": "string"
},
{
- "description": "Upload volume/template for the project",
+ "description": "the checksum value of this volume/template The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{<algorithm>}\", not including the double quotes. In this <algorithm> is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.",
"length": 255,
- "name": "projectid",
+ "name": "checksum",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed",
+ "length": 255,
+ "name": "ostypeid",
"related": "",
"required": false,
"type": "uuid"
@@ -107571,9 +109146,9 @@
"type": "string"
},
{
- "description": "true if the ISO or its derivatives are extractable; default is false",
+ "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true",
"length": 255,
- "name": "isextractable",
+ "name": "bootable",
"required": false,
"type": "boolean"
}
@@ -107581,11 +109156,6 @@
"related": "",
"response": [
{
- "description": "POST url to upload the file to",
- "name": "postURL",
- "type": "url"
- },
- {
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
@@ -107596,27 +109166,32 @@
"type": "string"
},
{
- "description": "the template/volume ID",
- "name": "id",
- "type": "uuid"
+ "description": "encrypted data to be sent in the POST request.",
+ "name": "metadata",
+ "type": "string"
},
+ {},
+ {},
{
"description": "signature to be sent in the POST request.",
"name": "signature",
"type": "string"
},
- {},
{
"description": "the timestamp after which the signature expires",
"name": "expires",
"type": "string"
},
{
- "description": "encrypted data to be sent in the POST request.",
- "name": "metadata",
- "type": "string"
+ "description": "the template/volume ID",
+ "name": "id",
+ "type": "uuid"
},
- {}
+ {
+ "description": "POST url to upload the file to",
+ "name": "postURL",
+ "type": "url"
+ }
],
"since": "4.13"
},
@@ -107643,22 +109218,22 @@
],
"related": "",
"response": [
- {},
{
"description": "Storage URL to download retrieve diagnostics data files",
"name": "url",
"type": "string"
},
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
{},
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
+ },
+ {},
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
}
],
"since": "4.14.0.0"
@@ -107683,18 +109258,18 @@
"name": "success",
"type": "boolean"
},
+ {},
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
+ {},
{
"description": "any text associated with the success or failure",
"name": "displaytext",
"type": "string"
},
- {},
- {},
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
@@ -107708,29 +109283,6 @@
"name": "listPaloAltoFirewalls",
"params": [
{
- "description": "Palo Alto firewall device ID",
- "length": 255,
- "name": "fwdeviceid",
- "related": "addPaloAltoFirewall,listPaloAltoFirewalls",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
- },
- {
- "description": "the Physical Network ID",
- "length": 255,
- "name": "physicalnetworkid",
- "related": "",
- "required": false,
- "type": "uuid"
- },
- {
"description": "",
"length": 255,
"name": "page",
@@ -107743,101 +109295,124 @@
"name": "pagesize",
"required": false,
"type": "integer"
+ },
+ {
+ "description": "Palo Alto firewall device ID",
+ "length": 255,
+ "name": "fwdeviceid",
+ "related": "addPaloAltoFirewall,listPaloAltoFirewalls",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "the Physical Network ID",
+ "length": 255,
+ "name": "physicalnetworkid",
+ "related": "",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
}
],
"related": "addPaloAltoFirewall",
"response": [
{
+ "description": "the physical network to which this Palo Alto firewall belongs to",
+ "name": "physicalnetworkid",
+ "type": "string"
+ },
+ {
+ "description": "the private interface of the external firewall",
+ "name": "privateinterface",
+ "type": "string"
+ },
+ {
+ "description": "device capacity",
+ "name": "fwdevicecapacity",
+ "type": "long"
+ },
+ {
+ "description": "device state",
+ "name": "fwdevicestate",
+ "type": "string"
+ },
+ {
+ "description": "the number of times to retry requests to the external firewall",
+ "name": "numretries",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the private security zone of the external firewall",
+ "name": "privatezone",
+ "type": "string"
+ },
+ {
+ "description": "device name",
+ "name": "fwdevicename",
+ "type": "string"
+ },
+ {},
+ {
"description": "the usage interface of the external firewall",
"name": "usageinterface",
"type": "string"
},
{
+ "description": "device id of the Palo Alto firewall",
+ "name": "fwdeviceid",
+ "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 timeout (in seconds) for requests to the external firewall",
+ "name": "timeout",
+ "type": "string"
+ },
+ {
+ "description": "the public interface of the external firewall",
+ "name": "publicinterface",
+ "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",
+ "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 timeout (in seconds) for requests to the external firewall",
- "name": "timeout",
- "type": "string"
- },
- {
- "description": "the public security zone of the external firewall",
- "name": "publiczone",
- "type": "string"
- },
- {
- "description": "the number of times to retry requests to the external firewall",
- "name": "numretries",
- "type": "string"
- },
- {
- "description": "the public interface of the external firewall",
- "name": "publicinterface",
- "type": "string"
- },
- {
- "description": "device name",
- "name": "fwdevicename",
- "type": "string"
- },
- {
"description": "the management IP address of the external firewall",
"name": "ipaddress",
"type": "string"
- },
- {
- "description": "the private interface of the external firewall",
- "name": "privateinterface",
- "type": "string"
- },
- {
- "description": "the username that's used to log in to the external firewall",
- "name": "username",
- "type": "string"
- },
- {
- "description": "device id of the Palo Alto firewall",
- "name": "fwdeviceid",
- "type": "string"
- },
- {
- "description": "device capacity",
- "name": "fwdevicecapacity",
- "type": "long"
- },
- {
- "description": "name of the provider",
- "name": "provider",
- "type": "string"
- },
- {
- "description": "the private security zone of the external firewall",
- "name": "privatezone",
- "type": "string"
- },
- {
- "description": "the physical network to which this Palo Alto firewall belongs to",
- "name": "physicalnetworkid",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "device state",
- "name": "fwdevicestate",
- "type": "string"
}
]
},
@@ -107847,14 +109422,6 @@
"name": "updateLoadBalancerRule",
"params": [
{
- "description": "an optional field, whether to the display the rule to the end user or not",
- "length": 255,
- "name": "fordisplay",
- "required": false,
- "since": "4.4",
- "type": "boolean"
- },
- {
"description": "the ID of the load balancer rule to update",
"length": 255,
"name": "id",
@@ -107863,6 +109430,35 @@
"type": "uuid"
},
{
+ "description": "the description of the load balancer rule",
+ "length": 4096,
+ "name": "description",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the name of the load balancer rule",
+ "length": 255,
+ "name": "name",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "The protocol for the LB",
+ "length": 255,
+ "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",
+ "required": false,
+ "since": "4.4",
+ "type": "boolean"
+ },
+ {
"description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only",
"length": 255,
"name": "customid",
@@ -107876,90 +109472,18 @@
"name": "algorithm",
"required": false,
"type": "string"
- },
- {
- "description": "the name of the load balancer rule",
- "length": 255,
- "name": "name",
- "required": false,
- "type": "string"
- },
- {
- "description": "the description of the load balancer rule",
- "length": 4096,
- "name": "description",
- "required": false,
- "type": "string"
- },
- {
- "description": "The protocol for the LB",
- "length": 255,
- "name": "protocol",
- "required": false,
- "type": "string"
}
],
"related": "listLoadBalancerRules",
"response": [
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the account of the load balancer rule",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the 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": "is rule for display to the regular user",
- "name": "fordisplay",
- "type": "boolean"
- },
- {
- "description": "the name of the zone the load balancer rule belongs to",
- "name": "zonename",
- "type": "string"
- },
- {},
- {
- "description": "the load balancer rule ID",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the private port",
- "name": "privateport",
- "type": "string"
- },
- {
"description": "the id of the guest network the lb rule belongs to",
"name": "networkid",
"type": "string"
},
{
- "description": "the id of the zone the rule belongs to",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the description of the load balancer",
- "name": "description",
- "type": "string"
- },
- {
- "description": "the project id of the load balancer",
- "name": "projectid",
+ "description": "the load balancer rule ID",
+ "name": "id",
"type": "string"
},
{
@@ -107968,39 +109492,18 @@
"type": "string"
},
{
- "description": "the protocol of the loadbalanacer rule",
- "name": "protocol",
+ "description": "the id of the zone the rule belongs to",
+ "name": "zoneid",
"type": "string"
},
{
- "description": "the domain of the load balancer rule",
- "name": "domain",
+ "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).",
+ "name": "cidrlist",
"type": "string"
},
{
- "description": "the project name of the load balancer",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the public port",
- "name": "publicport",
- "type": "string"
- },
- {},
- {
- "description": "the public ip address",
- "name": "publicip",
- "type": "string"
- },
- {
- "description": "the public ip address id",
- "name": "publicipid",
- "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"
},
{
@@ -108008,8 +109511,13 @@
"name": "tags",
"response": [
{
- "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",
"type": "string"
},
{
@@ -108018,8 +109526,8 @@
"type": "string"
},
{
- "description": "id of the resource",
- "name": "resourceid",
+ "description": "tag key name",
+ "name": "key",
"type": "string"
},
{
@@ -108028,8 +109536,13 @@
"type": "string"
},
{
- "description": "the project name where tag belongs to",
- "name": "project",
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
"type": "string"
},
{
@@ -108046,29 +109559,91 @@
"description": "the domain associated with the tag",
"name": "domain",
"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": "list"
},
{
- "description": "the load balancer algorithm (source, roundrobin, leastconn)",
- "name": "algorithm",
+ "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": "the domain of the load balancer rule",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the public ip address id",
+ "name": "publicipid",
+ "type": "string"
+ },
+ {
+ "description": "the protocol of the loadbalanacer rule",
+ "name": "protocol",
+ "type": "string"
+ },
+ {
+ "description": "the private port",
+ "name": "privateport",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "is rule for display to the regular user",
+ "name": "fordisplay",
+ "type": "boolean"
+ },
+ {
"description": "the state of the rule",
"name": "state",
"type": "string"
+ },
+ {
+ "description": "the domain ID of the load balancer rule",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the description of the load balancer",
+ "name": "description",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the public ip address",
+ "name": "publicip",
+ "type": "string"
+ },
+ {
+ "description": "the project id of the load balancer",
+ "name": "projectid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the project name of the load balancer",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the name of the zone the load balancer rule belongs to",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "the public port",
+ "name": "publicport",
+ "type": "string"
}
]
},
@@ -108078,6 +109653,14 @@
"name": "deleteAlerts",
"params": [
{
+ "description": "the IDs of the alerts",
+ "length": 255,
+ "name": "ids",
+ "related": "",
+ "required": false,
+ "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\")",
"length": 255,
"name": "startdate",
@@ -108085,51 +109668,43 @@
"type": "date"
},
{
+ "description": "end date range to delete alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")",
+ "length": 255,
+ "name": "enddate",
+ "required": false,
+ "type": "date"
+ },
+ {
"description": "delete by alert type",
"length": 255,
"name": "type",
"required": false,
"type": "string"
- },
- {
- "description": "the IDs of the alerts",
- "length": 255,
- "name": "ids",
- "related": "",
- "required": false,
- "type": "list"
- },
- {
- "description": "end date range to delete alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")",
- "length": 255,
- "name": "enddate",
- "required": false,
- "type": "date"
}
],
"response": [
+ {},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
{
+ "description": "true if operation is executed successfully",
+ "name": "success",
+ "type": "boolean"
+ },
+ {},
+ {
"description": "any text associated with the success or failure",
"name": "displaytext",
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {},
- {
- "description": "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"
+ }
]
},
{
@@ -108138,6 +109713,13 @@
"name": "enableAccount",
"params": [
{
+ "description": "Enables specified account.",
+ "length": 255,
+ "name": "account",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "Account id",
"length": 255,
"name": "id",
@@ -108146,13 +109728,6 @@
"type": "uuid"
},
{
- "description": "Enables specified account.",
- "length": 255,
- "name": "account",
- "required": false,
- "type": "string"
- },
- {
"description": "Enables specified account in this domain.",
"length": 255,
"name": "domainid",
@@ -108163,251 +109738,25 @@
],
"related": "listAccounts",
"response": [
- {
- "description": "the total memory (in MB) the account can own",
- "name": "memorylimit",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "name of the Domain the account belongs to",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the total number of public ip addresses this account can acquire",
- "name": "iplimit",
- "type": "string"
- },
+ {},
{
"description": "the total memory (in MB) available to be created for this account",
"name": "memoryavailable",
"type": "string"
},
{
- "description": "the total number of virtual machines available for this account to acquire",
- "name": "vmavailable",
- "type": "string"
- },
- {
- "description": "the total number of network traffic bytes received",
- "name": "receivedbytes",
- "type": "long"
- },
- {
- "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": "the total number of templates which have been created by this account",
- "name": "templatetotal",
- "type": "long"
- },
- {
- "description": "the total number of cpu cores the account can own",
- "name": "cpulimit",
- "type": "string"
- },
- {
- "description": "the total number of cpu cores available to be created for this account",
- "name": "cpuavailable",
- "type": "string"
- },
- {
- "description": "the total number of networks available to be created for this account",
- "name": "networkavailable",
- "type": "string"
- },
- {
- "description": "true if the account requires cleanup",
- "name": "iscleanuprequired",
- "type": "boolean"
- },
- {
- "description": "account type (admin, domain-admin, user)",
- "name": "accounttype",
- "type": "short"
- },
- {
- "description": "the total number of snapshots available for this account",
- "name": "snapshotavailable",
- "type": "string"
- },
- {
- "description": "the list of users associated with account",
- "name": "user",
- "response": [
- {
- "description": "the user ID",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the user state",
- "name": "state",
- "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": "true if user is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
- },
- {
- "description": "the api key of the user",
- "name": "apikey",
- "type": "string"
- },
- {
- "description": "the account ID of the user",
- "name": "accountid",
- "type": "string"
- },
- {
- "description": "the user name",
- "name": "username",
- "type": "string"
- },
- {
- "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 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 account name of the user",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the user firstname",
- "name": "firstname",
- "type": "string"
- },
- {
- "description": "the date and time the user account was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the user email address",
- "name": "email",
- "type": "string"
- },
- {
- "description": "the ID of the role",
- "name": "roleid",
- "type": "string"
- },
- {
- "description": "the domain ID of the user",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the type of the role",
- "name": "roletype",
- "type": "string"
- },
- {
- "description": "the domain name of the user",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the account type of the user",
- "name": "accounttype",
- "type": "short"
- }
- ],
- "type": "list"
- },
- {
- "description": "the total number of projects the account can own",
- "name": "projectlimit",
- "type": "string"
- },
- {
- "description": "the default zone of the account",
- "name": "defaultzoneid",
- "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",
+ "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 templates which can be created by this account",
- "name": "templatelimit",
- "type": "string"
- },
- {
- "description": "the total number of projects available for administration by this account",
- "name": "projectavailable",
- "type": "string"
- },
- {
- "description": "the total number of vpcs the account can own",
- "name": "vpclimit",
- "type": "string"
- },
- {
- "description": "the list of acl groups that account belongs to",
- "name": "groups",
- "type": "list"
- },
- {
- "description": "id of the Domain the account belongs to",
- "name": "domainid",
+ "description": "the total number of projects the account can own",
+ "name": "projectlimit",
"type": "string"
},
{
@@ -108416,150 +109765,103 @@
"type": "long"
},
{
- "description": "the total number of virtual machines stopped for this account",
- "name": "vmstopped",
- "type": "integer"
- },
- {},
- {
- "description": "the total number of virtual machines running for this account",
- "name": "vmrunning",
- "type": "integer"
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
},
{
- "description": "true if account is default, false otherwise",
- "name": "isdefault",
+ "description": "true if the account requires cleanup",
+ "name": "iscleanuprequired",
"type": "boolean"
},
{
- "description": "the name of the account",
- "name": "name",
- "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 networks owned by account",
- "name": "networktotal",
- "type": "long"
- },
- {
- "description": "the id of the account",
- "name": "id",
- "type": "string"
- },
- {
- "description": "details for the account",
- "name": "accountdetails",
- "type": "map"
- },
- {
- "description": "the total primary storage space (in GiB) owned by account",
- "name": "primarystoragetotal",
- "type": "long"
- },
- {
- "description": "the total number of snapshots stored by this account",
- "name": "snapshottotal",
- "type": "long"
- },
- {
- "description": "the ID of the role",
- "name": "roleid",
- "type": "string"
- },
- {
- "description": "the state of the account",
- "name": "state",
- "type": "string"
- },
- {
"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 total number of cpu cores available to be created for this account",
+ "name": "cpuavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of virtual machines deployed by this account",
+ "name": "vmtotal",
+ "type": "long"
+ },
+ {
+ "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",
+ "type": "string"
+ },
+ {
"description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)",
"name": "roletype",
"type": "string"
},
{
- "description": "the total number of snapshots which can be stored by this account",
- "name": "snapshotlimit",
+ "description": "details for the account",
+ "name": "accountdetails",
+ "type": "map"
+ },
+ {
+ "description": "true if account is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {
+ "description": "the total memory (in MB) the account can own",
+ "name": "memorylimit",
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "the total primary storage space (in GiB) available to be used for this account",
+ "name": "primarystorageavailable",
+ "type": "string"
},
{
- "description": "the total volume being used by this account",
- "name": "volumetotal",
+ "description": "the total number of snapshots stored by this account",
+ "name": "snapshottotal",
"type": "long"
},
{
- "description": "the total number of virtual machines deployed by this account",
- "name": "vmtotal",
- "type": "long"
- },
- {
- "description": "the total primary storage space (in GiB) the account can own",
- "name": "primarystoragelimit",
+ "description": "the total number of vpcs the account can own",
+ "name": "vpclimit",
"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 allocated for this account",
- "name": "iptotal",
- "type": "long"
- },
- {
- "description": "path of the Domain the account belongs to",
- "name": "domainpath",
+ "description": "the total number of projects available for administration by this account",
+ "name": "projectavailable",
"type": "string"
},
{
- "description": "the network domain",
- "name": "networkdomain",
+ "description": "the total secondary storage space (in GiB) available to be used for this account",
+ "name": "secondarystorageavailable",
"type": "string"
},
{
- "description": "the total number of vpcs available to be created for this account",
- "name": "vpcavailable",
+ "description": "the total secondary storage space (in GiB) the account can own",
+ "name": "secondarystoragelimit",
"type": "string"
},
{
- "description": "the name of the role",
- "name": "rolename",
+ "description": "the ID of the role",
+ "name": "roleid",
"type": "string"
},
{
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
- },
- {
- "description": "the date when this account was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the total number of virtual machines that can be deployed by this account",
- "name": "vmlimit",
+ "description": "the id of the account",
+ "name": "id",
"type": "string"
},
{
@@ -108568,8 +109870,190 @@
"type": "long"
},
{
- "description": "the total number of templates available to be created by this account",
- "name": "templateavailable",
+ "description": "the network domain",
+ "name": "networkdomain",
+ "type": "string"
+ },
+ {
+ "description": "the total primary storage space (in GiB) owned by account",
+ "name": "primarystoragetotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of public ip addresses this account can acquire",
+ "name": "iplimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of templates which can be created by this account",
+ "name": "templatelimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of snapshots which can be stored by this account",
+ "name": "snapshotlimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of networks the account can own",
+ "name": "networklimit",
+ "type": "string"
+ },
+ {
+ "description": "name of the Domain the account belongs to",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the total number of public ip addresses available for this account to acquire",
+ "name": "ipavailable",
+ "type": "string"
+ },
+ {
+ "description": "the list of users associated with account",
+ "name": "user",
+ "response": [
+ {
+ "description": "the account ID of the user",
+ "name": "accountid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the role",
+ "name": "roleid",
+ "type": "string"
+ },
+ {
+ "description": "the domain name of the user",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the secret key of the user",
+ "name": "secretkey",
+ "type": "string"
+ },
+ {
+ "description": "true if user is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {
+ "description": "the user name",
+ "name": "username",
+ "type": "string"
+ },
+ {
+ "description": "the type of the role",
+ "name": "roletype",
+ "type": "string"
+ },
+ {
+ "description": "the account type of the user",
+ "name": "accounttype",
+ "type": "short"
+ },
+ {
+ "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 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": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "description": "the user state",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "the user email address",
+ "name": "email",
+ "type": "string"
+ },
+ {
+ "description": "the user firstname",
+ "name": "firstname",
+ "type": "string"
+ },
+ {
+ "description": "the user ID",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the name of the role",
+ "name": "rolename",
+ "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 api key of the user",
+ "name": "apikey",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID of the user",
+ "name": "domainid",
+ "type": "string"
+ }
+ ],
+ "type": "list"
+ },
+ {
+ "description": "the total number of snapshots available for this account",
+ "name": "snapshotavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of virtual machines stopped for this account",
+ "name": "vmstopped",
+ "type": "integer"
+ },
+ {
+ "description": "account type (admin, domain-admin, user)",
+ "name": "accounttype",
+ "type": "short"
+ },
+ {
+ "description": "the default zone of the account",
+ "name": "defaultzoneid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the role",
+ "name": "rolename",
+ "type": "string"
+ },
+ {
+ "description": "id of the Domain the account belongs to",
+ "name": "domainid",
"type": "string"
},
{
@@ -108578,8 +110062,99 @@
"type": "long"
},
{
- "description": "the total number of public ip addresses available for this account to acquire",
- "name": "ipavailable",
+ "description": "path of the Domain the account belongs to",
+ "name": "domainpath",
+ "type": "string"
+ },
+ {
+ "description": "the date when this account was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the total 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 UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the total number of templates available to be created by this account",
+ "name": "templateavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total volume being used by this account",
+ "name": "volumetotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of public ip addresses allocated for this account",
+ "name": "iptotal",
+ "type": "long"
+ },
+ {
+ "description": "the total primary storage space (in GiB) the account can own",
+ "name": "primarystoragelimit",
+ "type": "string"
+ },
+ {
+ "description": "the state of the account",
+ "name": "state",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the total number of virtual machines running for this account",
+ "name": "vmrunning",
+ "type": "integer"
+ },
+ {
+ "description": "the total number of networks owned by account",
+ "name": "networktotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of network traffic bytes received",
+ "name": "receivedbytes",
+ "type": "long"
+ },
+ {
+ "description": "the total number of projects being administrated by this account",
+ "name": "projecttotal",
+ "type": "long"
+ },
+ {
+ "description": "the name of the account",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "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 number of virtual machines available for this account to acquire",
+ "name": "vmavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of virtual machines that can be deployed by this account",
+ "name": "vmlimit",
"type": "string"
}
]
@@ -108590,20 +110165,26 @@
"name": "createAutoScaleVmProfile",
"params": [
{
- "description": "the service offering of the auto deployed virtual machine",
+ "description": "availability zone for the auto deployed virtual machine",
"length": 255,
- "name": "serviceofferingid",
- "related": "updateServiceOffering,listServiceOfferings",
+ "name": "zoneid",
+ "related": "listZones",
"required": true,
"type": "uuid"
},
{
- "description": "an optional field, whether to the display the profile to the end user or not",
+ "description": "counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161",
"length": 255,
- "name": "fordisplay",
+ "name": "counterparam",
"required": false,
- "since": "4.4",
- "type": "boolean"
+ "type": "map"
+ },
+ {
+ "description": "parameters other than zoneId/serviceOfferringId/templateId of the auto deployed virtual machine",
+ "length": 255,
+ "name": "otherdeployparams",
+ "required": false,
+ "type": "string"
},
{
"description": "the time allowed for existing connections to get closed before a vm is destroyed",
@@ -108621,18 +110202,12 @@
"type": "uuid"
},
{
- "description": "parameters other than zoneId/serviceOfferringId/templateId of the auto deployed virtual machine",
+ "description": "the service offering of the auto deployed virtual machine",
"length": 255,
- "name": "otherdeployparams",
- "required": false,
- "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"
+ "name": "serviceofferingid",
+ "related": "updateServiceOffering,listServiceOfferings",
+ "required": true,
+ "type": "uuid"
},
{
"description": "the ID of the user used to launch and destroy the VMs",
@@ -108643,12 +110218,12 @@
"type": "uuid"
},
{
- "description": "availability zone for the auto deployed virtual machine",
+ "description": "an optional field, whether to the display the profile to the end user or not",
"length": 255,
- "name": "zoneid",
- "related": "listZones",
- "required": true,
- "type": "uuid"
+ "name": "fordisplay",
+ "required": false,
+ "since": "4.4",
+ "type": "boolean"
}
],
"related": "",
@@ -108659,56 +110234,8 @@
"type": "string"
},
{
- "description": "the domain name of the vm profile",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the project id vm profile",
- "name": "projectid",
- "type": "string"
- },
- {},
- {
- "description": "the autoscale vm profile ID",
- "name": "id",
- "type": "string"
- },
- {
- "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine",
- "name": "otherdeployparams",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the account owning the instance group",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the availability zone to be used while deploying a virtual machine",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the template to be used while deploying a virtual machine",
- "name": "templateid",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {},
- {},
- {
- "description": "the domain ID of the vm profile",
- "name": "domainid",
+ "description": "the ID of the user used to launch and destroy the VMs",
+ "name": "autoscaleuserid",
"type": "string"
},
{
@@ -108717,20 +110244,68 @@
"type": "string"
},
{
- "description": "the ID of the user used to launch and destroy the VMs",
- "name": "autoscaleuserid",
+ "description": "is profile for display to the regular user",
+ "name": "fordisplay",
+ "type": "boolean"
+ },
+ {},
+ {
+ "description": "the template to be used while deploying a virtual machine",
+ "name": "templateid",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the project id vm profile",
+ "name": "projectid",
"type": "string"
},
{},
{
- "description": "is profile for display to the regular user",
- "name": "fordisplay",
- "type": "boolean"
+ "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",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the account owning the instance group",
+ "name": "account",
+ "type": "string"
},
{
"description": "the time allowed for existing connections to get closed before a vm is destroyed",
"name": "destroyvmgraceperiod",
"type": "integer"
+ },
+ {
+ "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine",
+ "name": "otherdeployparams",
+ "type": "string"
+ },
+ {
+ "description": "the autoscale vm profile ID",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the domain name of the vm profile",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID of the vm profile",
+ "name": "domainid",
+ "type": "string"
}
]
},
@@ -108740,29 +110315,6 @@
"name": "listLBStickinessPolicies",
"params": [
{
- "description": "",
- "length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
- },
- {
- "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter",
- "length": 255,
- "name": "fordisplay",
- "required": false,
- "since": "4.4",
- "type": "boolean"
- },
- {
- "description": "the ID of the load balancer rule",
- "length": 255,
- "name": "lbruleid",
- "related": "",
- "required": false,
- "type": "uuid"
- },
- {
"description": "the ID of the load balancer stickiness policy",
"length": 255,
"name": "id",
@@ -108778,19 +110330,61 @@
"type": "string"
},
{
+ "description": "the ID of the load balancer rule",
+ "length": 255,
+ "name": "lbruleid",
+ "related": "",
+ "required": false,
+ "type": "uuid"
+ },
+ {
"description": "",
"length": 255,
"name": "pagesize",
"required": false,
"type": "integer"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "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": "",
"response": [
- {},
{
- "description": "the name of the Stickiness policy",
- "name": "name",
+ "description": "the state of the policy",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "the description of the Stickiness policy",
+ "name": "description",
+ "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 id of the zone the Stickiness policy belongs to",
+ "name": "zoneid",
"type": "string"
},
{
@@ -108799,12 +110393,28 @@
"type": "integer"
},
{
- "description": "the state of the policy",
- "name": "state",
+ "description": "the LB rule ID",
+ "name": "lbruleid",
"type": "string"
},
{},
{
+ "description": "the domain ID of the Stickiness policy",
+ "name": "domainid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the name of the Stickiness policy",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the account of the Stickiness policy",
+ "name": "account",
+ "type": "string"
+ },
+ {
"description": "the list of stickinesspolicies",
"name": "stickinesspolicy",
"response": [
@@ -108814,8 +110424,13 @@
"type": "string"
},
{
- "description": "the description of the Stickiness policy",
- "name": "description",
+ "description": "the name of the Stickiness policy",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the method name of the Stickiness policy",
+ "name": "methodname",
"type": "string"
},
{
@@ -108824,62 +110439,22 @@
"type": "boolean"
},
{
- "description": "the method name of the Stickiness policy",
- "name": "methodname",
+ "description": "the description of the Stickiness policy",
+ "name": "description",
"type": "string"
},
{
- "description": "the params of the policy",
- "name": "params",
- "type": "map"
- },
- {
"description": "the state of the policy",
"name": "state",
"type": "string"
},
{
- "description": "the name of the Stickiness policy",
- "name": "name",
- "type": "string"
+ "description": "the params of the policy",
+ "name": "params",
+ "type": "map"
}
],
"type": "list"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "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 account of the Stickiness policy",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the LB rule ID",
- "name": "lbruleid",
- "type": "string"
- },
- {
- "description": "the description of the Stickiness policy",
- "name": "description",
- "type": "string"
- },
- {
- "description": "the domain of the Stickiness policy",
- "name": "domain",
- "type": "string"
}
],
"since": "3.0.0"
@@ -108890,9 +110465,9 @@
"name": "addUcsManager",
"params": [
{
- "description": "the password of UCS",
+ "description": "the username of UCS",
"length": 255,
- "name": "password",
+ "name": "username",
"required": true,
"type": "string"
},
@@ -108911,9 +110486,9 @@
"type": "string"
},
{
- "description": "the username of UCS",
+ "description": "the password of UCS",
"length": 255,
- "name": "username",
+ "name": "password",
"required": true,
"type": "string"
},
@@ -108928,15 +110503,24 @@
],
"related": "",
"response": [
- {},
+ {
+ "description": "the name of ucs manager",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the url of ucs manager",
+ "name": "url",
+ "type": "string"
+ },
{
"description": "the zone ID of ucs manager",
"name": "zoneid",
"type": "string"
},
{
- "description": "the url of ucs manager",
- "name": "url",
+ "description": "the ID of the ucs manager",
+ "name": "id",
"type": "string"
},
{},
@@ -108945,20 +110529,11 @@
"name": "jobid",
"type": "string"
},
- {
- "description": "the name of ucs manager",
- "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 ucs manager",
- "name": "id",
- "type": "string"
}
]
},
@@ -108968,27 +110543,27 @@
"name": "deleteNetwork",
"params": [
{
+ "description": "Force delete a network. Network will be marked as 'Destroy' even when commands to shutdown and cleanup to the backend fails.",
+ "length": 255,
+ "name": "forced",
+ "required": false,
+ "type": "boolean"
+ },
+ {
"description": "the ID of the network",
"length": 255,
"name": "id",
"related": "createNetwork,updateNetwork,listNetworks",
"required": true,
"type": "uuid"
- },
- {
- "description": "Force delete a network. Network will be marked as 'Destroy' even when commands to shutdown and cleanup to the backend fails.",
- "length": 255,
- "name": "forced",
- "required": false,
- "type": "boolean"
}
],
"response": [
{},
{
- "description": "the UUID of the latest async job acting on 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",
@@ -109000,12 +110575,12 @@
"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"
+ },
+ {}
]
},
{
@@ -109025,29 +110600,9 @@
"related": "addBaremetalHost",
"response": [
{
- "description": "the resource state of the host",
- "name": "resourcestate",
- "type": "string"
- },
- {
- "description": "the CPU number of the host",
- "name": "cpunumber",
- "type": "integer"
- },
- {
- "description": "capabilities of the host",
- "name": "capabilities",
- "type": "string"
- },
- {
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "the management server ID of the host",
- "name": "managementserverid",
- "type": "string"
+ "description": "the cpu average load on the host",
+ "name": "cpuloadaverage",
+ "type": "double"
},
{
"description": "true if local storage is active, false otherwise",
@@ -109055,264 +110610,18 @@
"type": "boolean"
},
{
- "description": "the state of the host",
- "name": "state",
- "type": "status"
- },
- {
- "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise",
- "name": "suitableformigration",
- "type": "boolean"
- },
- {
- "description": "the amount of the host's memory currently allocated in percentage",
- "name": "memoryallocatedpercentage",
- "type": "string"
- },
- {
- "description": "the host version",
- "name": "version",
- "type": "string"
- },
- {
- "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning",
- "name": "memorytotal",
- "type": "long"
- },
- {
- "description": "true if the host is disconnected. False otherwise.",
- "name": "disconnected",
- "type": "date"
- },
- {
- "description": "the name of the host",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the last annotation set on this host by an admin",
- "name": "annotation",
- "type": "string"
- },
- {
- "description": "the admin that annotated this host",
- "name": "username",
- "type": "string"
- },
- {
"description": "the date and time the host was created",
"name": "created",
"type": "date"
},
{
- "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise",
- "name": "hasenoughcapacity",
- "type": "boolean"
- },
- {
"description": "the amount of the host's CPU currently allocated in MHz",
"name": "cpuallocatedvalue",
"type": "long"
},
{
- "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor",
- "name": "cpuwithoverprovisioning",
- "type": "string"
- },
- {
- "description": "the cpu average load on the host",
- "name": "cpuloadaverage",
- "type": "double"
- },
- {
- "description": "the Pod ID of the host",
- "name": "podid",
- "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 memory currently allocated in bytes",
- "name": "memoryallocatedbytes",
- "type": "long"
- },
- {
- "description": "the cluster name of the host",
- "name": "clustername",
- "type": "string"
- },
- {
- "description": "the amount of the host's memory currently used",
- "name": "memoryused",
- "type": "long"
- },
- {
- "description": "the total disk size of the host",
- "name": "disksizetotal",
- "type": "long"
- },
- {},
- {
- "description": "the date and time the host was removed",
- "name": "removed",
- "type": "date"
- },
- {
- "description": "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": "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": "Video RAM for this vGPU type",
- "name": "videoram",
- "type": "long"
- },
- {
- "description": "Maximum Y resolution per display",
- "name": "maxresolutiony",
- "type": "long"
- },
- {
- "description": "Model Name of vGPU",
- "name": "vgputype",
- "type": "string"
- },
- {
- "description": "Maximum X resolution per display",
- "name": "maxresolutionx",
- "type": "long"
- },
- {
- "description": "Maximum 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"
- }
- ],
- "type": "list"
- }
- ],
- "type": "list"
- },
- {
- "description": "the date and time the host was last pinged",
- "name": "lastpinged",
- "type": "date"
- },
- {
- "description": "the host hypervisor",
- "name": "hypervisor",
- "type": "hypervisortype"
- },
- {
- "description": "the CPU speed of the host",
- "name": "cpuspeed",
- "type": "long"
- },
- {
- "description": "the cluster ID of the host",
- "name": "clusterid",
- "type": "string"
- },
- {
- "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor",
- "name": "cpuallocatedwithoverprovisioning",
- "type": "string"
- },
- {
- "description": "the number of CPU sockets on the host",
- "name": "cpusockets",
- "type": "integer"
- },
- {},
- {
- "description": "the incoming network traffic on the host",
- "name": "networkkbsread",
- "type": "long"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the cluster type of the cluster that host belongs to",
- "name": "clustertype",
- "type": "string"
- },
- {
- "description": "the host HA information information",
- "name": "hostha",
- "type": "hostharesponse"
- },
- {
- "description": "the OS category name of the host",
- "name": "oscategoryname",
- "type": "string"
- },
- {
- "description": "the Pod name of the host",
- "name": "podname",
- "type": "string"
- },
- {
- "description": "the ID of the host",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the OS category ID of the host",
- "name": "oscategoryid",
- "type": "string"
- },
- {
- "description": "the amount of the host's CPU currently used",
- "name": "cpuused",
- "type": "string"
- },
- {
- "description": "the amount of the host's CPU currently allocated",
- "name": "cpuallocated",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
@@ -109321,48 +110630,98 @@
"type": "date"
},
{
- "description": "the outgoing network traffic on the host",
- "name": "networkkbswrite",
- "type": "long"
- },
- {
- "description": "the amount of the host's memory currently allocated",
- "name": "memoryallocated",
- "type": "long"
- },
- {
- "description": "the hypervisor version",
- "name": "hypervisorversion",
- "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 UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "GPU cards present in the host",
+ "name": "gpugroup",
+ "response": [
+ {
+ "description": "the list of enabled vGPUs",
+ "name": "vgpu",
+ "response": [
+ {
+ "description": "Maximum X resolution per display",
+ "name": "maxresolutionx",
+ "type": "long"
+ },
+ {
+ "description": "Maximum vgpu can be created with this vgpu type on the given gpu group",
+ "name": "maxcapacity",
+ "type": "long"
+ },
+ {
+ "description": "Maximum displays per user",
+ "name": "maxheads",
+ "type": "long"
+ },
+ {
+ "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type",
+ "name": "remainingcapacity",
+ "type": "long"
+ },
+ {
+ "description": "Video RAM for this vGPU type",
+ "name": "videoram",
+ "type": "long"
+ },
+ {
+ "description": "Maximum no. of vgpu per gpu card (pgpu)",
+ "name": "maxvgpuperpgpu",
+ "type": "long"
+ },
+ {
+ "description": "Model Name of vGPU",
+ "name": "vgputype",
+ "type": "string"
+ },
+ {
+ "description": "Maximum Y resolution per display",
+ "name": "maxresolutiony",
+ "type": "long"
+ }
+ ],
+ "type": "list"
+ },
+ {
+ "description": "GPU cards present in the host",
+ "name": "gpugroupname",
+ "type": "string"
+ }
+ ],
+ "type": "list"
+ },
+ {},
+ {
+ "description": "the host hypervisor",
+ "name": "hypervisor",
+ "type": "hypervisortype"
+ },
+ {
+ "description": "the amount of the host's memory currently allocated in bytes",
+ "name": "memoryallocatedbytes",
+ "type": "long"
+ },
+ {
+ "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 CPU speed of the host",
+ "name": "cpuspeed",
+ "type": "long"
},
{
- "description": "the host out-of-band management information",
- "name": "outofbandmanagement",
- "type": "outofbandmanagementresponse"
+ "description": "the ID of the host",
+ "name": "id",
+ "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"
},
{
@@ -109371,19 +110730,430 @@
"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 resource state of the host",
+ "name": "resourcestate",
+ "type": "string"
+ },
+ {
+ "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise",
+ "name": "suitableformigration",
+ "type": "boolean"
+ },
+ {
"description": "the host type",
"name": "type",
"type": "type"
},
{
+ "description": "Host details in key/value pairs.",
+ "name": "details",
+ "type": "map"
+ },
+ {
+ "description": "the total disk size of the host",
+ "name": "disksizetotal",
+ "type": "long"
+ },
+ {
+ "description": "capabilities of the host",
+ "name": "capabilities",
+ "type": "string"
+ },
+ {
+ "description": "the host's currently allocated disk size",
+ "name": "disksizeallocated",
+ "type": "long"
+ },
+ {
+ "description": "the cluster name of the host",
+ "name": "clustername",
+ "type": "string"
+ },
+ {
+ "description": "the hypervisor version",
+ "name": "hypervisorversion",
+ "type": "string"
+ },
+ {
"description": "events available for the host",
"name": "events",
"type": "string"
},
{
- "description": "the Zone name of the host",
+ "description": "the host out-of-band management information",
+ "name": "outofbandmanagement",
+ "type": "outofbandmanagementresponse"
+ },
+ {
+ "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor",
+ "name": "cpuallocatedwithoverprovisioning",
+ "type": "string"
+ },
+ {
+ "description": "the name of the host",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the date and time the host was last pinged",
+ "name": "lastpinged",
+ "type": "date"
+ },
+ {
+ "description": "the host HA information information",
+ "name": "hostha",
+ "type": "hostharesponse"
+ },
+ {
+ "description": "the cluster type of the cluster that host belongs to",
+ "name": "clustertype",
+ "type": "string"
+ },
+ {
+ "description": "the admin that annotated this host",
+ "name": "username",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the host's CPU currently allocated",
+ "name": "cpuallocated",
+ "type": "string"
+ },
+ {
+ "description": "the incoming network traffic on the host",
+ "name": "networkkbsread",
+ "type": "long"
+ },
+ {
+ "description": "the amount of the host's memory currently used",
+ "name": "memoryused",
+ "type": "long"
+ },
+ {
+ "description": "the state of the host",
+ "name": "state",
+ "type": "status"
+ },
+ {
+ "description": "the date and time the host was removed",
+ "name": "removed",
+ "type": "date"
+ },
+ {
+ "description": "the cluster ID of the host",
+ "name": "clusterid",
+ "type": "string"
+ },
+ {
+ "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": "the host version",
+ "name": "version",
+ "type": "string"
+ },
+ {
+ "description": "the Pod ID of the host",
+ "name": "podid",
+ "type": "string"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the amount of the host's CPU currently allocated in percentage",
+ "name": "cpuallocatedpercentage",
+ "type": "string"
+ },
+ {
+ "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise",
+ "name": "hahost",
+ "type": "boolean"
+ },
+ {
+ "description": "the OS category ID of the host",
+ "name": "oscategoryid",
+ "type": "string"
+ },
+ {
+ "description": "the management server ID of the host",
+ "name": "managementserverid",
+ "type": "string"
+ },
+ {
+ "description": "the OS category name of the host",
+ "name": "oscategoryname",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the host's CPU currently used",
+ "name": "cpuused",
+ "type": "string"
+ },
+ {
+ "description": "the Pod name of the host",
+ "name": "podname",
+ "type": "string"
+ },
+ {
+ "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning",
+ "name": "memorytotal",
+ "type": "long"
+ },
+ {},
+ {
+ "description": "the 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 Zone ID of the host",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the number of CPU sockets on the host",
+ "name": "cpusockets",
+ "type": "integer"
+ },
+ {
+ "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor",
+ "name": "cpuwithoverprovisioning",
+ "type": "string"
+ },
+ {
+ "description": "true if the host is disconnected. False otherwise.",
+ "name": "disconnected",
+ "type": "date"
+ },
+ {
+ "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 percentage",
+ "name": "memoryallocatedpercentage",
+ "type": "string"
+ }
+ ]
+ },
+ {
+ "description": "Starts a stopped Kubernetes cluster",
+ "isasync": true,
+ "name": "startKubernetesCluster",
+ "params": [
+ {
+ "description": "the ID of the Kubernetes cluster",
+ "length": 255,
+ "name": "id",
+ "related": "startKubernetesCluster",
+ "required": true,
+ "type": "uuid"
+ }
+ ],
+ "related": "",
+ "response": [
+ {},
+ {
+ "description": "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",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "Whether autoscaling is enabled for the cluster",
+ "name": "autoscalingenabled",
+ "type": "boolean"
+ },
+ {
+ "description": "the ID of the domain in which the Kubernetes cluster exists",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "URL end point for the Kubernetes cluster",
+ "name": "endpoint",
+ "type": "string"
+ },
+ {
+ "description": "the name of the zone of the Kubernetes cluster",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the id of the Kubernetes cluster",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "URL end point for the Kubernetes cluster dashboard UI",
+ "name": "consoleendpoint",
+ "type": "string"
+ },
+ {
+ "description": "the memory the Kubernetes cluster",
+ "name": "memory",
+ "type": "string"
+ },
+ {
+ "description": "keypair details",
+ "name": "keypair",
+ "type": "string"
+ },
+ {
+ "description": "the name of the domain in which the Kubernetes cluster exists",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the list of virtualmachine associated with this Kubernetes cluster",
+ "name": "virtualmachines",
+ "type": "list"
+ },
+ {
+ "description": "the project name of the Kubernetes cluster",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the control nodes count for the Kubernetes cluster",
+ "name": "controlnodes",
+ "type": "long"
+ },
+ {
+ "description": "Maximum size of the cluster",
+ "name": "maxsize",
+ "type": "long"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the Kubernetes version for the Kubernetes cluster",
+ "name": "kubernetesversionname",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the network of the Kubernetes cluster",
+ "name": "networkid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the Kubernetes version for the Kubernetes cluster",
+ "name": "kubernetesversionid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the zone of the Kubernetes cluster",
"name": "zonename",
"type": "string"
+ },
+ {
+ "description": "the name of the Kubernetes cluster",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "Public IP Address of the cluster",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "Public IP Address ID of the cluster",
+ "name": "ipaddressid",
+ "type": "string"
+ },
+ {
+ "description": "the description of the Kubernetes cluster",
+ "name": "description",
+ "type": "string"
+ },
+ {
+ "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",
+ "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 size (worker nodes count) of the Kubernetes cluster",
+ "name": "size",
+ "type": "long"
+ },
+ {
+ "description": "the cpu cores of the Kubernetes cluster",
+ "name": "cpunumber",
+ "type": "string"
+ },
+ {
+ "description": "the state of the Kubernetes cluster",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the template of the Kubernetes cluster",
+ "name": "templateid",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the Kubernetes cluster",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "Minimum size of the cluster",
+ "name": "minsize",
+ "type": "long"
}
]
},
@@ -109412,12 +111182,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"
@@ -109427,6 +111191,12 @@
"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",
@@ -109448,6 +111218,13 @@
"type": "integer"
},
{
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "the Physical Network ID",
"length": 255,
"name": "physicalnetworkid",
@@ -109469,76 +111246,59 @@
"name": "page",
"required": false,
"type": "integer"
- },
- {
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
}
],
"related": "addNetscalerLoadBalancer",
"response": [
{
- "description": "device id of the netscaler load balancer",
- "name": "lbdeviceid",
- "type": "string"
- },
- {
- "description": "device capacity",
- "name": "lbdevicecapacity",
- "type": "long"
- },
- {
"description": "true if device is dedicated for an account",
"name": "lbdevicededicated",
"type": "boolean"
},
{
+ "description": "the management IP address of the external load balancer",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "device id of the netscaler load balancer",
+ "name": "lbdeviceid",
+ "type": "string"
+ },
+ {},
+ {
"description": "the private interface of the load balancer",
"name": "privateinterface",
"type": "string"
},
{
+ "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": "the physical network to which this netscaler device belongs to",
- "name": "physicalnetworkid",
- "type": "string"
- },
- {
- "description": "the management IP address of the external load balancer",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider",
- "name": "isexclusivegslbprovider",
- "type": "boolean"
- },
- {},
- {
"description": "name of the provider",
"name": "provider",
"type": "string"
},
{
- "description": "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 state",
"name": "lbdevicestate",
"type": "string"
},
{
- "description": "device name",
- "name": "lbdevicename",
+ "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"
},
{
@@ -109547,25 +111307,35 @@
"type": "boolean"
},
{
- "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",
- "type": "string"
- },
- {},
- {
"description": "public IP of the NetScaler representing GSLB site",
"name": "gslbproviderpublicip",
"type": "string"
},
{
+ "description": "device capacity",
+ "name": "lbdevicecapacity",
+ "type": "long"
+ },
+ {
"description": "the public interface of the load balancer",
"name": "publicinterface",
"type": "string"
+ },
+ {},
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "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"
}
]
},
@@ -109582,14 +111352,6 @@
"type": "string"
},
{
- "description": "The project of the instance group",
- "length": 255,
- "name": "projectid",
- "related": "",
- "required": false,
- "type": "uuid"
- },
- {
"description": "the domain ID of account owning the instance group",
"length": 255,
"name": "domainid",
@@ -109603,6 +111365,14 @@
"name": "name",
"required": true,
"type": "string"
+ },
+ {
+ "description": "The project of the instance group",
+ "length": 255,
+ "name": "projectid",
+ "related": "",
+ "required": false,
+ "type": "uuid"
}
],
"related": "",
@@ -109613,47 +111383,6 @@
"type": "string"
},
{
- "description": "the name of the instance group",
- "name": "name",
- "type": "string"
- },
- {},
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the project name of the instance group",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the account owning the instance group",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the domain name of the instance group",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the ID of the instance group",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
"description": "the domain ID of the instance group",
"name": "domainid",
"type": "string"
@@ -109663,7 +111392,48 @@
"name": "created",
"type": "date"
},
- {}
+ {},
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the instance group",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the account owning the instance group",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the instance group",
+ "name": "id",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the name of the instance group",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the domain name of the instance group",
+ "name": "domain",
+ "type": "string"
+ }
]
},
{
@@ -109682,31 +111452,20 @@
],
"related": "listTemplatePermissions,listIsoPermissions",
"response": [
- {},
{
- "description": "true if this template is a public template, false otherwise",
- "name": "ispublic",
- "type": "boolean"
+ "description": "the list of accounts the template is available for",
+ "name": "account",
+ "type": "list"
},
{},
{
- "description": "the template ID",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the ID of the domain to which the template belongs",
- "name": "domainid",
- "type": "string"
- },
- {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
{
- "description": "the list of accounts the template is available for",
- "name": "account",
+ "description": "the list of projects the template is available for",
+ "name": "projectids",
"type": "list"
},
{
@@ -109715,9 +111474,20 @@
"type": "integer"
},
{
- "description": "the list of projects the template is available for",
- "name": "projectids",
- "type": "list"
+ "description": "the ID of the domain to which the template belongs",
+ "name": "domainid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the template ID",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "true if this template is a public template, false otherwise",
+ "name": "ispublic",
+ "type": "boolean"
}
]
},
@@ -109734,6 +111504,27 @@
"type": "string"
},
{
+ "description": "public IP of the site",
+ "length": 255,
+ "name": "gslbproviderprivateip",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "Credentials to reach netscaler load balancer device",
+ "length": 255,
+ "name": "username",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "public IP of the site",
+ "length": 255,
+ "name": "gslbproviderpublicip",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "the Physical Network ID",
"length": 255,
"name": "physicalnetworkid",
@@ -109742,6 +111533,13 @@
"type": "uuid"
},
{
+ "description": "true if NetScaler device being added is for providing GSLB service",
+ "length": 255,
+ "name": "gslbprovider",
+ "required": false,
+ "type": "boolean"
+ },
+ {
"description": "Netscaler device type supports NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer",
"length": 255,
"name": "networkdevicetype",
@@ -109756,71 +111554,38 @@
"type": "boolean"
},
{
- "description": "public IP of the site",
- "length": 255,
- "name": "gslbproviderprivateip",
- "required": false,
- "type": "string"
- },
- {
"description": "URL of the netscaler load balancer appliance.",
"length": 255,
"name": "url",
"required": true,
"type": "string"
- },
- {
- "description": "public IP of the site",
- "length": 255,
- "name": "gslbproviderpublicip",
- "required": false,
- "type": "string"
- },
- {
- "description": "Credentials to reach netscaler load balancer device",
- "length": 255,
- "name": "username",
- "required": true,
- "type": "string"
- },
- {
- "description": "true if NetScaler device being added is for providing GSLB service",
- "length": 255,
- "name": "gslbprovider",
- "required": false,
- "type": "boolean"
}
],
"related": "",
"response": [
{
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "name of the provider",
+ "name": "provider",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "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": "private IP of the NetScaler representing GSLB site",
"name": "gslbproviderprivateip",
"type": "string"
},
- {
- "description": "true if device is dedicated for an account",
- "name": "lbdevicededicated",
- "type": "boolean"
- },
{},
{
- "description": "device state",
- "name": "lbdevicestate",
- "type": "string"
- },
- {
- "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": "device id of the netscaler load balancer",
"name": "lbdeviceid",
"type": "string"
@@ -109831,14 +111596,19 @@
"type": "string"
},
{
+ "description": "device state",
+ "name": "lbdevicestate",
+ "type": "string"
+ },
+ {
"description": "the public interface of the load balancer",
"name": "publicinterface",
"type": "string"
},
{
- "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider",
- "name": "isexclusivegslbprovider",
- "type": "boolean"
+ "description": "public IP of the NetScaler representing GSLB site",
+ "name": "gslbproviderpublicip",
+ "type": "string"
},
{
"description": "the physical network to which this netscaler device belongs to",
@@ -109846,9 +111616,9 @@
"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",
@@ -109856,24 +111626,24 @@
"type": "string"
},
{
+ "description": "true if device is dedicated for an account",
+ "name": "lbdevicededicated",
+ "type": "boolean"
+ },
+ {
+ "description": "device name",
+ "name": "lbdevicename",
+ "type": "string"
+ },
+ {
"description": "true if NetScaler device is provisioned to be a GSLB service provider",
"name": "gslbprovider",
"type": "boolean"
},
{
- "description": "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": "device name",
- "name": "lbdevicename",
- "type": "string"
+ "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider",
+ "name": "isexclusivegslbprovider",
+ "type": "boolean"
},
{
"description": "device capacity",
@@ -109888,11 +111658,11 @@
"name": "createLoadBalancer",
"params": [
{
- "description": "the source port the network traffic will be load balanced from",
- "length": 255,
- "name": "sourceport",
- "required": true,
- "type": "integer"
+ "description": "the description of the load balancer",
+ "length": 4096,
+ "name": "description",
+ "required": false,
+ "type": "string"
},
{
"description": "the load balancer scheme. Supported value in this release is Internal",
@@ -109902,6 +111672,13 @@
"type": "string"
},
{
+ "description": "load balancer algorithm (source, roundrobin, leastconn)",
+ "length": 255,
+ "name": "algorithm",
+ "required": true,
+ "type": "string"
+ },
+ {
"description": "the network id of the source ip address",
"length": 255,
"name": "sourceipaddressnetworkid",
@@ -109910,11 +111687,12 @@
"type": "uuid"
},
{
- "description": "name of the load balancer",
+ "description": "The guest network the load balancer will be created for",
"length": 255,
- "name": "name",
+ "name": "networkid",
+ "related": "createNetwork,updateNetwork,listNetworks",
"required": true,
- "type": "string"
+ "type": "uuid"
},
{
"description": "the TCP port of the virtual machine where the network traffic will be load balanced to",
@@ -109924,28 +111702,6 @@
"type": "integer"
},
{
- "description": "the description of the load balancer",
- "length": 4096,
- "name": "description",
- "required": false,
- "type": "string"
- },
- {
- "description": "load balancer algorithm (source, roundrobin, leastconn)",
- "length": 255,
- "name": "algorithm",
- "required": true,
- "type": "string"
- },
- {
- "description": "The guest network the load balancer will be created for",
- "length": 255,
- "name": "networkid",
- "related": "createNetwork,updateNetwork,listNetworks",
- "required": true,
- "type": "uuid"
- },
- {
"description": "the source IP address the network traffic will be load balanced from",
"length": 255,
"name": "sourceipaddress",
@@ -109953,35 +111709,39 @@
"type": "string"
},
{
+ "description": "the source port the network traffic will be load balanced from",
+ "length": 255,
+ "name": "sourceport",
+ "required": true,
+ "type": "integer"
+ },
+ {
"description": "an optional field, whether to the display the rule to the end user or not",
"length": 255,
"name": "fordisplay",
"required": false,
"since": "4.4",
"type": "boolean"
+ },
+ {
+ "description": "name of the load balancer",
+ "length": 255,
+ "name": "name",
+ "required": true,
+ "type": "string"
}
],
"related": "",
"response": [
{
- "description": "Load Balancer network id",
- "name": "networkid",
- "type": "string"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
{
- "description": "the description of the Load Balancer",
- "name": "description",
- "type": "string"
- },
- {
- "description": "the domain of the Load Balancer",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the account of the Load Balancer",
- "name": "account",
- "type": "string"
+ "description": "is rule for display to the regular user",
+ "name": "fordisplay",
+ "type": "boolean"
},
{
"description": "the project id of the Load Balancer",
@@ -109989,68 +111749,13 @@
"type": "string"
},
{
- "description": "the load balancer algorithm (source, roundrobin, leastconn)",
- "name": "algorithm",
+ "description": "the name of the Load Balancer",
+ "name": "name",
"type": "string"
},
{
- "description": "the list of instances associated with the Load Balancer",
- "name": "loadbalancerinstance",
- "response": [
- {
- "description": "the instance ID",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the name of the instance",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the state of the instance",
- "name": "state",
- "type": "string"
- },
- {
- "description": "the ip address of the instance",
- "name": "ipaddress",
- "type": "string"
- }
- ],
- "type": "list"
- },
- {},
- {
- "description": "Load Balancer source ip",
- "name": "sourceipaddress",
- "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": "Load Balancer source ip network id",
- "name": "sourceipaddressnetworkid",
+ "description": "the Load Balancer ID",
+ "name": "id",
"type": "string"
},
{
@@ -110059,50 +111764,36 @@
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the domain ID of the Load Balancer",
- "name": "domainid",
+ "description": "the load balancer algorithm (source, roundrobin, leastconn)",
+ "name": "algorithm",
"type": "string"
},
{
+ "description": "the domain of the Load Balancer",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "Load Balancer source ip network id",
+ "name": "sourceipaddressnetworkid",
+ "type": "string"
+ },
+ {
+ "description": "the description of the Load Balancer",
+ "name": "description",
+ "type": "string"
+ },
+ {},
+ {
"description": "the list of resource tags associated with the Load Balancer",
"name": "tags",
"response": [
{
- "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": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
"description": "the account associated with the tag",
"name": "account",
"type": "string"
@@ -110113,14 +111804,39 @@
"type": "string"
},
{
- "description": "tag key name",
- "name": "key",
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
"type": "string"
},
{
"description": "the domain associated with the tag",
"name": "domain",
"type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
}
],
"type": "list"
@@ -110130,20 +111846,74 @@
"name": "project",
"type": "string"
},
+ {
+ "description": "the account of the Load Balancer",
+ "name": "account",
+ "type": "string"
+ },
{},
{
- "description": "the Load Balancer ID",
- "name": "id",
+ "description": "Load Balancer source ip",
+ "name": "sourceipaddress",
"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 name of the Load Balancer",
- "name": "name",
+ "description": "the list of instances associated with the Load Balancer",
+ "name": "loadbalancerinstance",
+ "response": [
+ {
+ "description": "the name of the instance",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the ip address of the instance",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "the state of the instance",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "the instance ID",
+ "name": "id",
+ "type": "string"
+ }
+ ],
+ "type": "list"
+ },
+ {
+ "description": "the list of rules associated with the Load Balancer",
+ "name": "loadbalancerrule",
+ "response": [
+ {
+ "description": "source port of the load balancer rule",
+ "name": "sourceport",
+ "type": "integer"
+ },
+ {
+ "description": "the state of the load balancer rule",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "instance port of the load balancer rule",
+ "name": "instanceport",
+ "type": "integer"
+ }
+ ],
+ "type": "list"
+ },
+ {
+ "description": "the domain ID of the Load Balancer",
+ "name": "domainid",
"type": "string"
}
],
@@ -110162,20 +111932,6 @@
"type": "integer"
},
{
- "description": "",
- "length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
- },
- {
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
- },
- {
"description": "the Physical Network ID",
"length": 255,
"name": "physicalnetworkid",
@@ -110189,20 +111945,39 @@
"name": "id",
"required": false,
"type": "long"
+ },
+ {
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
}
],
"related": "",
"response": [
{},
{
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
"description": "device id of ",
"name": "id",
"type": "string"
},
{
- "description": "the physical network to which this external dhcp device belongs to",
- "name": "physicalnetworkid",
- "type": "string"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
{},
{
@@ -110211,18 +111986,13 @@
"type": "string"
},
{
- "description": "the current status of the latest 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": "url",
+ "name": "url",
"type": "string"
},
{
- "description": "url",
- "name": "url",
+ "description": "the physical network to which this external dhcp device belongs to",
+ "name": "physicalnetworkid",
"type": "string"
}
]
@@ -110233,9 +112003,9 @@
"name": "addPaloAltoFirewall",
"params": [
{
- "description": "supports only PaloAltoFirewall",
+ "description": "Credentials to reach Palo Alto firewall device",
"length": 255,
- "name": "networkdevicetype",
+ "name": "password",
"required": true,
"type": "string"
},
@@ -110254,53 +112024,26 @@
"type": "string"
},
{
+ "description": "supports only PaloAltoFirewall",
+ "length": 255,
+ "name": "networkdevicetype",
+ "required": true,
+ "type": "string"
+ },
+ {
"description": "the Physical Network ID",
"length": 255,
"name": "physicalnetworkid",
"related": "",
"required": true,
"type": "uuid"
- },
- {
- "description": "Credentials to reach Palo Alto firewall device",
- "length": 255,
- "name": "password",
- "required": true,
- "type": "string"
}
],
"related": "",
"response": [
{
- "description": "device state",
- "name": "fwdevicestate",
- "type": "string"
- },
- {},
- {
- "description": "the public interface of the external firewall",
- "name": "publicinterface",
- "type": "string"
- },
- {},
- {
- "description": "the usage interface of the external firewall",
- "name": "usageinterface",
- "type": "string"
- },
- {
- "description": "the public security zone of the external firewall",
- "name": "publiczone",
- "type": "string"
- },
- {
- "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": "device name",
+ "name": "fwdevicename",
"type": "string"
},
{
@@ -110309,21 +112052,6 @@
"type": "string"
},
{
- "description": "name of the provider",
- "name": "provider",
- "type": "string"
- },
- {
- "description": "device id of the Palo Alto firewall",
- "name": "fwdeviceid",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
"description": "the private security zone of the external firewall",
"name": "privatezone",
"type": "string"
@@ -110334,13 +112062,13 @@
"type": "string"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "name of the provider",
+ "name": "provider",
"type": "string"
},
{
- "description": "the username that's used to log in to the external firewall",
- "name": "username",
+ "description": "the zone ID of the external firewall",
+ "name": "zoneid",
"type": "string"
},
{
@@ -110349,19 +112077,61 @@
"type": "long"
},
{
- "description": "device name",
- "name": "fwdevicename",
+ "description": "the usage interface of the external firewall",
+ "name": "usageinterface",
"type": "string"
},
{
- "description": "the physical network to which this Palo Alto firewall belongs to",
- "name": "physicalnetworkid",
+ "description": "device state",
+ "name": "fwdevicestate",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the public interface of the external firewall",
+ "name": "publicinterface",
+ "type": "string"
+ },
+ {
+ "description": "the number of times to retry requests to the external firewall",
+ "name": "numretries",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "device id of the Palo Alto firewall",
+ "name": "fwdeviceid",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the username that's used to log in to the external firewall",
+ "name": "username",
+ "type": "string"
+ },
+ {
+ "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",
"type": "string"
+ },
+ {
+ "description": "the physical network to which this Palo Alto firewall belongs to",
+ "name": "physicalnetworkid",
+ "type": "string"
}
]
},
@@ -110371,9 +112141,9 @@
"name": "createPrivateGateway",
"params": [
{
- "description": "the netmask of the Private gateway",
+ "description": "the gateway of the Private gateway",
"length": 255,
- "name": "netmask",
+ "name": "gateway",
"required": true,
"type": "string"
},
@@ -110394,6 +112164,21 @@
"type": "uuid"
},
{
+ "description": "when true bypasses VLAN id/range overlap check during private gateway creation",
+ "length": 255,
+ "name": "bypassvlanoverlapcheck",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "the VPC network belongs to",
+ "length": 255,
+ "name": "vpcid",
+ "related": "createVPC,listVPCs,updateVPC",
+ "required": true,
+ "type": "uuid"
+ },
+ {
"description": "the network implementation uri for the private gateway",
"length": 255,
"name": "vlan",
@@ -110401,6 +112186,13 @@
"type": "string"
},
{
+ "description": "source NAT supported value. Default value false. If 'true' source NAT is enabled on the private gateway 'false': sourcenat is not supported",
+ "length": 255,
+ "name": "sourcenatsupported",
+ "required": false,
+ "type": "boolean"
+ },
+ {
"description": "the IP address of the Private gateaway",
"length": 255,
"name": "ipaddress",
@@ -110416,72 +112208,19 @@
"type": "uuid"
},
{
- "description": "the VPC network belongs to",
+ "description": "the netmask of the Private gateway",
"length": 255,
- "name": "vpcid",
- "related": "createVPC,listVPCs,updateVPC",
- "required": true,
- "type": "uuid"
- },
- {
- "description": "when true bypasses VLAN id/range overlap check during private gateway creation",
- "length": 255,
- "name": "bypassvlanoverlapcheck",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "the gateway of the Private gateway",
- "length": 255,
- "name": "gateway",
+ "name": "netmask",
"required": true,
"type": "string"
- },
- {
- "description": "source NAT supported value. Default value false. If 'true' source NAT is enabled on the private gateway 'false': sourcenat is not supported",
- "length": 255,
- "name": "sourcenatsupported",
- "required": false,
- "type": "boolean"
}
],
"related": "",
"response": [
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the project name of the private gateway",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the id of the private gateway",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the project id of the private gateway",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the account associated with the private gateway",
- "name": "account",
- "type": "string"
- },
- {
- "description": "ACL name set for private gateway",
- "name": "aclname",
- "type": "string"
- },
- {},
- {
- "description": "VPC id the private gateway belongs to",
- "name": "vpcid",
- "type": "string"
+ "description": "Souce Nat enable status",
+ "name": "sourcenatsupported",
+ "type": "boolean"
},
{
"description": "the domain associated with the private gateway",
@@ -110489,44 +112228,8 @@
"type": "string"
},
{
- "description": "ACL Id set for private gateway",
- "name": "aclid",
- "type": "string"
- },
- {
- "description": "the private gateway's ip address",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "description": "zone id of the private gateway",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the private gateway's netmask",
- "name": "netmask",
- "type": "string"
- },
- {
- "description": "Souce Nat enable status",
- "name": "sourcenatsupported",
- "type": "boolean"
- },
- {
- "description": "the gateway",
- "name": "gateway",
- "type": "string"
- },
- {
- "description": "VPC name the private gateway belongs to",
- "name": "vpcname",
- "type": "string"
- },
- {},
- {
- "description": "State of the gateway, can be Creating, Ready, Deleting",
- "name": "state",
+ "description": "the project id of the private gateway",
+ "name": "projectid",
"type": "string"
},
{
@@ -110540,8 +112243,54 @@
"type": "integer"
},
{
- "description": "the name of the zone the private gateway belongs to",
- "name": "zonename",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "VPC name the private gateway belongs to",
+ "name": "vpcname",
+ "type": "string"
+ },
+ {
+ "description": "zone id of the private gateway",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "ACL Id set for private gateway",
+ "name": "aclid",
+ "type": "string"
+ },
+ {
+ "description": "the private gateway's netmask",
+ "name": "netmask",
+ "type": "string"
+ },
+ {
+ "description": "VPC id the private gateway belongs to",
+ "name": "vpcid",
+ "type": "string"
+ },
+ {
+ "description": "the id of the private gateway",
+ "name": "id",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the physical network id",
+ "name": "physicalnetworkid",
+ "type": "string"
+ },
+ {
+ "description": "the gateway",
+ "name": "gateway",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the private gateway",
+ "name": "account",
"type": "string"
},
{
@@ -110549,9 +112298,30 @@
"name": "domainid",
"type": "string"
},
+ {},
{
- "description": "the physical network id",
- "name": "physicalnetworkid",
+ "description": "ACL name set for private gateway",
+ "name": "aclname",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the private gateway",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the name of the zone the private gateway belongs to",
+ "name": "zonename",
+ "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"
}
]
@@ -110571,101 +112341,9 @@
],
"related": "",
"response": [
- {},
{
- "description": "the user name",
- "name": "username",
- "type": "string"
- },
- {
- "description": "the date and time the user account was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the api key of the user",
- "name": "apikey",
- "type": "string"
- },
- {
- "description": "the ID of the role",
- "name": "roleid",
- "type": "string"
- },
- {
- "description": "the account name of the user",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the secret key of the user",
- "name": "secretkey",
- "type": "string"
- },
- {
- "description": "the type of the role",
- "name": "roletype",
- "type": "string"
- },
- {
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
- },
- {
- "description": "the user ID",
- "name": "id",
- "type": "string"
- },
- {},
- {
- "description": "the user email address",
- "name": "email",
- "type": "string"
- },
- {
- "description": "the name of the role",
- "name": "rolename",
- "type": "string"
- },
- {
- "description": "the user state",
- "name": "state",
- "type": "string"
- },
- {
- "description": "the user lastname",
- "name": "lastname",
- "type": "string"
- },
- {
- "description": "the source type of the user in lowercase, such as native, ldap, saml2",
- "name": "usersource",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the user firstname",
- "name": "firstname",
- "type": "string"
- },
- {
- "description": "true if user is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
- },
- {
- "description": "the account type of the user",
- "name": "accounttype",
- "type": "short"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the timezone user was created in",
+ "name": "timezone",
"type": "string"
},
{
@@ -110674,13 +112352,38 @@
"type": "string"
},
{
- "description": "the timezone user was created in",
- "name": "timezone",
+ "description": "the type of the role",
+ "name": "roletype",
"type": "string"
},
{
- "description": "the account ID of the user",
- "name": "accountid",
+ "description": "the account type of the user",
+ "name": "accounttype",
+ "type": "short"
+ },
+ {
+ "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 name of the role",
+ "name": "rolename",
+ "type": "string"
+ },
+ {
+ "description": "true if user is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {
+ "description": "the user name",
+ "name": "username",
"type": "string"
},
{
@@ -110689,9 +112392,76 @@
"type": "string"
},
{
- "description": "the boolean value representing if the updating target is in caller's child domain",
- "name": "iscallerchilddomain",
- "type": "boolean"
+ "description": "the secret key of the user",
+ "name": "secretkey",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the role",
+ "name": "roleid",
+ "type": "string"
+ },
+ {
+ "description": "the api key of the user",
+ "name": "apikey",
+ "type": "string"
+ },
+ {
+ "description": "the user state",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "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": "the user firstname",
+ "name": "firstname",
+ "type": "string"
+ },
+ {
+ "description": "the user email address",
+ "name": "email",
+ "type": "string"
+ },
+ {
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "description": "the account name of the user",
+ "name": "account",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {},
+ {
+ "description": "the user lastname",
+ "name": "lastname",
+ "type": "string"
+ },
+ {
+ "description": "the user ID",
+ "name": "id",
+ "type": "string"
}
]
},
@@ -110701,6 +112471,20 @@
"name": "listLoadBalancerRules",
"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",
+ "length": 255,
+ "name": "listall",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
"description": "the ID of the load balancer rule",
"length": 255,
"name": "id",
@@ -110709,43 +112493,14 @@
"type": "uuid"
},
{
- "description": "the availability zone ID",
+ "description": "list objects by project",
"length": 255,
- "name": "zoneid",
- "related": "listZones",
+ "name": "projectid",
+ "related": "",
"required": false,
"type": "uuid"
},
{
- "description": "list by network ID the rule belongs to",
- "length": 255,
- "name": "networkid",
- "related": "createNetwork,updateNetwork,listNetworks",
- "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": "",
- "length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
- },
- {
"description": "the ID of the virtual machine of the load balancer rule",
"length": 255,
"name": "virtualmachineid",
@@ -110754,37 +112509,6 @@
"type": "uuid"
},
{
- "description": "the public IP address ID of the load balancer rule",
- "length": 255,
- "name": "publicipid",
- "related": "associateIpAddress,listPublicIpAddresses",
- "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 name of the load balancer rule",
- "length": 255,
- "name": "name",
- "required": false,
- "type": "string"
- },
- {
- "description": "list objects by project",
- "length": 255,
- "name": "projectid",
- "related": "",
- "required": false,
- "type": "uuid"
- },
- {
"description": "list resources by display flag; only ROOT admin is eligible to pass this parameter",
"length": 255,
"name": "fordisplay",
@@ -110793,6 +112517,28 @@
"type": "boolean"
},
{
+ "description": "list resources by account. Must be used with the domainId parameter.",
+ "length": 255,
+ "name": "account",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the availability zone ID",
+ "length": 255,
+ "name": "zoneid",
+ "related": "listZones",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "the name of the load balancer rule",
+ "length": 255,
+ "name": "name",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "List by keyword",
"length": 255,
"name": "keyword",
@@ -110802,41 +112548,59 @@
{
"description": "",
"length": 255,
- "name": "pagesize",
+ "name": "page",
"required": false,
"type": "integer"
},
{
- "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false",
+ "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
"length": 255,
- "name": "listall",
+ "name": "isrecursive",
"required": false,
"type": "boolean"
},
{
+ "description": "list by network ID the rule belongs to",
+ "length": 255,
+ "name": "networkid",
+ "related": "createNetwork,updateNetwork,listNetworks",
+ "required": false,
+ "type": "uuid"
+ },
+ {
"description": "List resources by tags (key/value pairs)",
"length": 255,
"name": "tags",
"required": false,
"type": "map"
+ },
+ {
+ "description": "list only resources belonging to the domain specified",
+ "length": 255,
+ "name": "domainid",
+ "related": "listDomains",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "the public IP address ID of the load balancer rule",
+ "length": 255,
+ "name": "publicipid",
+ "related": "associateIpAddress,listPublicIpAddresses",
+ "required": false,
+ "type": "uuid"
}
],
"related": "",
"response": [
{
- "description": "the id of the zone the rule belongs to",
- "name": "zoneid",
+ "description": "the domain of the load balancer rule",
+ "name": "domain",
"type": "string"
},
{
- "description": "the domain ID of the load balancer rule",
- "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"
},
{
@@ -110845,131 +112609,13 @@
"type": "string"
},
{
- "description": "the domain of the load balancer rule",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the public port",
- "name": "publicport",
- "type": "string"
- },
- {},
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the project id of the load balancer",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the project name of the load balancer",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the list of resource tags associated with load balancer",
- "name": "tags",
- "response": [
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "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": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- }
- ],
- "type": "list"
- },
- {
- "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 description of the load balancer",
- "name": "description",
- "type": "string"
- },
- {
- "description": "the account of the load balancer rule",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the load balancer rule ID",
- "name": "id",
- "type": "string"
- },
- {
- "description": "is rule for display to the regular user",
- "name": "fordisplay",
- "type": "boolean"
- },
- {
- "description": "the protocol of the loadbalanacer rule",
- "name": "protocol",
- "type": "string"
- },
- {
- "description": "the public ip address id",
- "name": "publicipid",
- "type": "string"
- },
- {
- "description": "the name of the load balancer",
- "name": "name",
+ "description": "the name of the zone the load balancer rule belongs to",
+ "name": "zonename",
"type": "string"
},
{
@@ -110978,8 +112624,102 @@
"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 port",
+ "name": "publicport",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID of the load balancer rule",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the public ip address id",
+ "name": "publicipid",
+ "type": "string"
+ },
+ {},
+ {},
+ {
+ "description": "the load balancer rule ID",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the project id of the load balancer",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the list of resource tags associated with load balancer",
+ "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": "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": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ }
+ ],
+ "type": "list"
+ },
+ {
+ "description": "the account of the load balancer rule",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the protocol of the loadbalanacer rule",
+ "name": "protocol",
"type": "string"
},
{
@@ -110988,8 +112728,38 @@
"type": "string"
},
{
- "description": "the name of the zone the load balancer rule belongs to",
- "name": "zonename",
+ "description": "the project name of the load balancer",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the id of the guest network the lb rule belongs to",
+ "name": "networkid",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the public ip address",
+ "name": "publicip",
+ "type": "string"
+ },
+ {
+ "description": "the description of the load balancer",
+ "name": "description",
+ "type": "string"
+ },
+ {
+ "description": "is rule for display to the regular user",
+ "name": "fordisplay",
+ "type": "boolean"
+ },
+ {
+ "description": "the id of the zone the rule belongs to",
+ "name": "zoneid",
"type": "string"
}
]
@@ -111009,6 +112779,7 @@
}
],
"response": [
+ {},
{
"description": "any text associated with the success or failure",
"name": "displaytext",
@@ -111029,8 +112800,7 @@
"description": "true if operation is executed successfully",
"name": "success",
"type": "boolean"
- },
- {}
+ }
]
},
{
@@ -111039,6 +112809,14 @@
"name": "uploadSslCert",
"params": [
{
+ "description": "Enables revocation checking for certificates",
+ "length": 255,
+ "name": "enabledrevocationcheck",
+ "required": false,
+ "since": "4.15",
+ "type": "boolean"
+ },
+ {
"description": "domain ID of the account owning the SSL certificate",
"length": 255,
"name": "domainid",
@@ -111047,6 +112825,13 @@
"type": "uuid"
},
{
+ "description": "SSL certificate",
+ "length": 16384,
+ "name": "certificate",
+ "required": true,
+ "type": "string"
+ },
+ {
"description": "account that will own the SSL certificate",
"length": 255,
"name": "account",
@@ -111054,16 +112839,16 @@
"type": "string"
},
{
- "description": "Private key",
- "length": 16384,
- "name": "privatekey",
- "required": true,
+ "description": "Certificate chain of trust",
+ "length": 2097152,
+ "name": "certchain",
+ "required": false,
"type": "string"
},
{
- "description": "SSL certificate",
+ "description": "Private key",
"length": 16384,
- "name": "certificate",
+ "name": "privatekey",
"required": true,
"type": "string"
},
@@ -111088,28 +112873,13 @@
"related": "",
"required": false,
"type": "uuid"
- },
- {
- "description": "Certificate chain of trust",
- "length": 2097152,
- "name": "certchain",
- "required": false,
- "type": "string"
- },
- {
- "description": "Enables revocation checking for certificates",
- "length": 255,
- "name": "enabledrevocationcheck",
- "required": false,
- "since": "4.15",
- "type": "boolean"
}
],
"related": "",
"response": [
{
- "description": "the project id of the certificate",
- "name": "projectid",
+ "description": "the domain name of the network owner",
+ "name": "domain",
"type": "string"
},
{
@@ -111117,7 +112887,6 @@
"name": "certificate",
"type": "string"
},
- {},
{
"description": "certificate fingerprint",
"name": "fingerprint",
@@ -111129,16 +112898,42 @@
"type": "string"
},
{
+ "description": "name",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the domain id of the network owner",
+ "name": "domainid",
+ "type": "string"
+ },
+ {},
+ {},
+ {
"description": "account for the certificate",
"name": "account",
"type": "string"
},
{
+ "description": "the project name of the certificate",
+ "name": "project",
+ "type": "string"
+ },
+ {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
- {},
+ {
+ "description": "List of loabalancers this certificate is bound to",
+ "name": "loadbalancerrulelist",
+ "type": "list"
+ },
+ {
+ "description": "the project id of the certificate",
+ "name": "projectid",
+ "type": "string"
+ },
{
"description": "certificate chain",
"name": "certchain",
@@ -111148,31 +112943,6 @@
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
- },
- {
- "description": "List of loabalancers this certificate is bound to",
- "name": "loadbalancerrulelist",
- "type": "list"
- },
- {
- "description": "the domain id of the network owner",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the domain name of the network owner",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the project name of the certificate",
- "name": "project",
- "type": "string"
- },
- {
- "description": "name",
- "name": "name",
- "type": "string"
}
]
},
@@ -111182,28 +112952,6 @@
"name": "createVpnCustomerGateway",
"params": [
{
- "description": "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.",
- "length": 255,
- "name": "ipsecpsk",
- "required": true,
- "type": "string"
- },
- {
- "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds",
- "length": 255,
- "name": "ikelifetime",
- "required": false,
- "type": "long"
- },
- {
- "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.",
- "length": 255,
- "name": "splitconnections",
- "required": false,
- "since": "4.15.1",
- "type": "boolean"
- },
- {
"description": "IKE policy of the customer gateway",
"length": 255,
"name": "ikepolicy",
@@ -111211,60 +112959,9 @@
"type": "string"
},
{
- "description": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds",
+ "description": "public ip address id of the customer gateway",
"length": 255,
- "name": "esplifetime",
- "required": false,
- "type": "long"
- },
- {
- "description": "the account associated with the gateway. Must be used with the domainId parameter.",
- "length": 255,
- "name": "account",
- "required": false,
- "type": "string"
- },
- {
- "description": "the domain ID associated with the gateway. If used with the account parameter returns the gateway associated with the account for the specified domain.",
- "length": 255,
- "name": "domainid",
- "related": "listDomains",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Connections marked with 'ike' will use 'ikev2' when initiating, but accept any protocol version when responding. Defaults to ike",
- "length": 255,
- "name": "ikeversion",
- "required": false,
- "since": "4.15.1",
- "type": "string"
- },
- {
- "description": "name of this customer gateway",
- "length": 255,
- "name": "name",
- "required": false,
- "type": "string"
- },
- {
- "description": "Force Encapsulation for NAT traversal",
- "length": 255,
- "name": "forceencap",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "guest cidr list of the customer gateway. Multiple entries must be separated by a single comma character (,).",
- "length": 255,
- "name": "cidrlist",
- "required": true,
- "type": "string"
- },
- {
- "description": "ESP policy of the customer gateway",
- "length": 255,
- "name": "esppolicy",
+ "name": "gateway",
"required": true,
"type": "string"
},
@@ -111278,6 +112975,13 @@
"type": "uuid"
},
{
+ "description": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds",
+ "length": 255,
+ "name": "esplifetime",
+ "required": false,
+ "type": "long"
+ },
+ {
"description": "If DPD is enabled for VPN connection",
"length": 255,
"name": "dpd",
@@ -111285,16 +112989,107 @@
"type": "boolean"
},
{
- "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": "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": "ESP policy of the customer gateway",
+ "length": 255,
+ "name": "esppolicy",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds",
+ "length": 255,
+ "name": "ikelifetime",
+ "required": false,
+ "type": "long"
+ },
+ {
+ "description": "the account associated with the gateway. Must be used with the domainId parameter.",
+ "length": 255,
+ "name": "account",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.",
+ "length": 255,
+ "name": "ipsecpsk",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "the domain ID associated with the gateway. If used with the account parameter returns the gateway associated with the account for the specified domain.",
+ "length": 255,
+ "name": "domainid",
+ "related": "listDomains",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "Force Encapsulation for NAT traversal",
+ "length": 255,
+ "name": "forceencap",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "name of this customer gateway",
+ "length": 255,
+ "name": "name",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.",
+ "length": 255,
+ "name": "splitconnections",
+ "required": false,
+ "since": "4.15.1",
+ "type": "boolean"
}
],
"related": "",
"response": [
{
+ "description": "guest ip of the customer gateway",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "IPsec preshared-key of customer gateway",
+ "name": "ipsecpsk",
+ "type": "string"
+ },
+ {
+ "description": "the vpn gateway ID",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "IPsec policy of customer gateway",
+ "name": "esppolicy",
+ "type": "string"
+ },
+ {
+ "description": "the project id",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
"description": "Lifetime of ESP SA of customer gateway",
"name": "esplifetime",
"type": "long"
@@ -111304,92 +113099,31 @@
"name": "ikeversion",
"type": "string"
},
- {},
- {
- "description": "the project id",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "IKE policy of customer gateway",
- "name": "ikepolicy",
- "type": "string"
- },
{
"description": "if DPD is enabled for customer gateway",
"name": "dpd",
"type": "boolean"
},
{
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
"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": "the project name",
- "name": "project",
- "type": "string"
- },
- {
- "description": "Lifetime of IKE SA of customer gateway",
- "name": "ikelifetime",
- "type": "long"
- },
- {
- "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": "the owner",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the domain name of the owner",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.",
- "name": "splitconnections",
- "type": "boolean"
- },
- {
- "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": "name of the customer gateway",
"name": "name",
"type": "string"
},
{
- "description": "IPsec policy of customer gateway",
- "name": "esppolicy",
+ "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": "if Force NAT Encapsulation is enabled for customer gateway",
@@ -111402,14 +113136,50 @@
"type": "string"
},
{
- "description": "IPsec preshared-key of customer gateway",
- "name": "ipsecpsk",
+ "description": "the domain name of the owner",
+ "name": "domain",
"type": "string"
},
{
- "description": "guest ip of the customer gateway",
- "name": "ipaddress",
+ "description": "IKE policy of customer gateway",
+ "name": "ikepolicy",
"type": "string"
+ },
+ {
+ "description": "Lifetime of IKE SA of customer gateway",
+ "name": "ikelifetime",
+ "type": "long"
+ },
+ {
+ "description": "the project name",
+ "name": "project",
+ "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": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.",
+ "name": "splitconnections",
+ "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"
}
]
},
@@ -111419,6 +113189,13 @@
"name": "createManagementNetworkIpRange",
"params": [
{
+ "description": "Specify if range is dedicated for CPVM and SSVM.",
+ "length": 255,
+ "name": "forsystemvms",
+ "required": false,
+ "type": "boolean"
+ },
+ {
"description": "UUID of POD, where the IP range belongs to.",
"length": 255,
"name": "podid",
@@ -111427,6 +113204,13 @@
"type": "uuid"
},
{
+ "description": "The gateway for the management network.",
+ "length": 255,
+ "name": "gateway",
+ "required": true,
+ "type": "string"
+ },
+ {
"description": "The netmask for the management network.",
"length": 255,
"name": "netmask",
@@ -111441,11 +113225,11 @@
"type": "string"
},
{
- "description": "Specify if range is dedicated for CPVM and SSVM.",
+ "description": "Optional. The vlan id the ip range sits on, default to Null when it is not specificed which means you network is not on any Vlan",
"length": 255,
- "name": "forsystemvms",
+ "name": "vlan",
"required": false,
- "type": "boolean"
+ "type": "string"
},
{
"description": "The starting IP address.",
@@ -111453,98 +113237,28 @@
"name": "startip",
"required": true,
"type": "string"
- },
- {
- "description": "The gateway for the management network.",
- "length": 255,
- "name": "gateway",
- "required": true,
- "type": "string"
- },
- {
- "description": "Optional. The vlan id the ip range sits on, default to Null when it is not specificed which means you network is not on any Vlan",
- "length": 255,
- "name": "vlan",
- "required": false,
- "type": "string"
}
],
"related": "",
"response": [
- {
- "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"
- },
- {
- "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.",
- "name": "startip",
- "type": "list"
- },
- {
- "description": "the allocation state of the Pod",
- "name": "allocationstate",
- "type": "string"
- },
- {
- "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.",
- "name": "endip",
- "type": "list"
- },
{},
{
- "description": "the netmask of the Pod",
- "name": "netmask",
- "type": "string"
- },
- {
- "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.",
- "name": "vlanid",
- "type": "list"
- },
- {
- "description": "the ID of the Pod",
- "name": "id",
- "type": "string"
- },
- {},
- {
- "description": "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 Zone ID",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the total capacity available",
- "name": "capacitytotal",
- "type": "long"
- },
- {
"description": "the capacity type",
"name": "type",
"type": "short"
},
{
- "description": "the Pod name",
- "name": "podname",
+ "description": "the capacity name",
+ "name": "name",
"type": "string"
},
{
- "description": "the Zone name",
- "name": "zonename",
+ "description": "the Pod name",
+ "name": "podname",
"type": "string"
},
{
@@ -111553,13 +113267,28 @@
"type": "long"
},
{
+ "description": "the Zone name",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
"description": "the Pod ID",
"name": "podid",
"type": "string"
},
{
- "description": "the capacity name",
- "name": "name",
+ "description": "the total capacity available",
+ "name": "capacitytotal",
+ "type": "long"
+ },
+ {
+ "description": "the Zone ID",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the Cluster ID",
+ "name": "clusterid",
"type": "string"
},
{
@@ -111576,45 +113305,61 @@
"description": "the percentage of capacity currently in use",
"name": "percentused",
"type": "string"
- },
- {
- "description": "the Cluster ID",
- "name": "clusterid",
- "type": "string"
}
],
"type": "list"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the Zone name of the Pod",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "the name of the Pod",
- "name": "name",
- "type": "string"
- },
- {
"description": "the gateway of the Pod",
"name": "gateway",
"type": "string"
},
{
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
+ "description": "the allocation state of the Pod",
+ "name": "allocationstate",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.",
+ "name": "startip",
+ "type": "list"
+ },
+ {},
+ {
+ "description": "the name of the Pod",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the Zone ID of the Pod",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the netmask of the Pod",
+ "name": "netmask",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the Pod",
+ "name": "id",
+ "type": "string"
},
{
"description": "the IP ranges for the Pod",
"name": "ipranges",
"response": [
{
+ "description": "the ending IP for the range",
+ "name": "endip",
+ "type": "string"
+ },
+ {
"description": "the starting IP for the range",
"name": "startip",
"type": "string"
@@ -111625,17 +113370,42 @@
"type": "string"
},
{
- "description": "the ending IP for the range",
- "name": "endip",
- "type": "string"
- },
- {
"description": "indicates if range is dedicated for CPVM and SSVM",
"name": "forsystemvms",
"type": "string"
}
],
"type": "list"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "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 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": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.",
+ "name": "endip",
+ "type": "list"
}
],
"since": "4.11.0.0"
@@ -111646,13 +113416,6 @@
"name": "listCiscoNexusVSMs",
"params": [
{
- "description": "",
- "length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
- },
- {
"description": "Id of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance.",
"length": 255,
"name": "zoneid",
@@ -111661,11 +113424,11 @@
"type": "uuid"
},
{
- "description": "",
+ "description": "List by keyword",
"length": 255,
- "name": "pagesize",
+ "name": "keyword",
"required": false,
- "type": "integer"
+ "type": "string"
},
{
"description": "Id of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance.",
@@ -111676,18 +113439,36 @@
"type": "uuid"
},
{
- "description": "List by keyword",
+ "description": "",
"length": 255,
- "name": "keyword",
+ "name": "page",
"required": false,
- "type": "string"
+ "type": "integer"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
}
],
"related": "",
"response": [
{
- "description": "The VSM is a switch supervisor. This is the VSM's switch domain id",
- "name": "vsmdomainid",
+ "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "device state",
+ "name": "vsmdevicestate",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "device name",
+ "name": "vsmdevicename",
"type": "string"
},
{
@@ -111696,29 +113477,24 @@
"type": "string"
},
{
- "description": "The mode of the VSM (standalone/HA)",
- "name": "vsmconfigmode",
- "type": "string"
- },
- {
- "description": "The Config State (Primary/Standby) of the VSM",
- "name": "vsmconfigstate",
- "type": "string"
- },
- {
- "description": "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 UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "device id of the Cisco N1KV VSM device",
+ "name": "vsmdeviceid",
+ "type": "string"
+ },
+ {
+ "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"
},
{
@@ -111727,34 +113503,28 @@
"type": "int"
},
{
- "description": "device id of the Cisco N1KV VSM device",
- "name": "vsmdeviceid",
- "type": "string"
- },
- {
- "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module",
- "name": "ipaddress",
- "type": "string"
- },
- {
"description": "control vlan id of the VSM",
"name": "vsmctrlvlanid",
"type": "int"
},
{
- "description": "management vlan id of the VSM",
- "name": "vsmmgmtvlanid",
+ "description": "The mode of the VSM (standalone/HA)",
+ "name": "vsmconfigmode",
"type": "string"
},
- {},
{
"description": "storage vlan id of the VSM",
"name": "vsmstoragevlanid",
"type": "int"
},
{
- "description": "device state",
- "name": "vsmdevicestate",
+ "description": "The Config State (Primary/Standby) of the VSM",
+ "name": "vsmconfigstate",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
}
]
@@ -111765,6 +113535,28 @@
"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": "an optional domainId for the vpn user. If the account parameter is used, domainId must also be used.",
+ "length": 255,
+ "name": "domainid",
+ "related": "listDomains",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "password for the username",
+ "length": 255,
+ "name": "password",
+ "required": true,
+ "type": "string"
+ },
+ {
"description": "username for the vpn user",
"length": 255,
"name": "username",
@@ -111778,46 +113570,24 @@
"related": "",
"required": false,
"type": "uuid"
- },
- {
- "description": "password for the username",
- "length": 255,
- "name": "password",
- "required": true,
- "type": "string"
- },
- {
- "description": "an optional domainId for the vpn user. If the account parameter is used, domainId must also be used.",
- "length": 255,
- "name": "domainid",
- "related": "listDomains",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "an optional account for the vpn user. Must be used with domainId.",
- "length": 255,
- "name": "account",
- "required": false,
- "type": "string"
}
],
"related": "",
"response": [
{},
{
- "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",
"type": "string"
},
{
- "description": "the username of the vpn user",
- "name": "username",
+ "description": "the project name of the vpn",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the project id of the vpn",
+ "name": "projectid",
"type": "string"
},
{
@@ -111826,21 +113596,16 @@
"type": "string"
},
{
- "description": "the vpn userID",
- "name": "id",
- "type": "string"
- },
- {
"description": "the state of the Vpn User",
"name": "state",
"type": "string"
},
+ {},
{
"description": "the domain id of the account of the remote access vpn",
"name": "domainid",
"type": "string"
},
- {},
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
@@ -111852,91 +113617,16 @@
"type": "string"
},
{
- "description": "the project id of the vpn",
- "name": "projectid",
- "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": "",
- "response": [
- {
- "description": "the contents of the annotation",
- "name": "annotation",
- "type": "string"
- },
- {
- "description": "the (uu)id of the entitiy to which this annotation pertains",
- "name": "entityid",
- "type": "string"
- },
- {},
- {},
- {
- "description": "the removal timestamp for this annotation",
- "name": "removed",
- "type": "date"
- },
- {
- "description": "the name of the entitiy to which this annotation pertains",
- "name": "entityname",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "The username of the user that entered the annotation",
+ "description": "the username of the vpn user",
"name": "username",
"type": "string"
},
{
- "description": "The (uu)id of the user that entered the annotation",
- "name": "userid",
- "type": "string"
- },
- {
- "description": "the type of the annotated entity",
- "name": "entitytype",
- "type": "string"
- },
- {
- "description": "the creation timestamp for this annotation",
- "name": "created",
- "type": "date"
- },
- {
- "description": "True if the annotation is available for admins only",
- "name": "adminsonly",
- "type": "boolean"
- },
- {
- "description": "the (uu)id of the annotation",
+ "description": "the vpn userID",
"name": "id",
"type": "string"
}
- ],
- "since": "4.11"
+ ]
},
{
"description": "add a baremetal host",
@@ -111944,56 +113634,6 @@
"name": "addBaremetalHost",
"params": [
{
- "description": "Allocation state of this Host for allocation of new resources",
- "length": 255,
- "name": "allocationstate",
- "required": false,
- "type": "string"
- },
- {
- "description": "the password for the host; required to be passed for hypervisors other than VMWare",
- "length": 255,
- "name": "password",
- "required": false,
- "type": "string"
- },
- {
- "description": "hypervisor type of the host",
- "length": 255,
- "name": "hypervisor",
- "required": true,
- "type": "string"
- },
- {
- "description": "ip address intentionally allocated to this host after provisioning",
- "length": 255,
- "name": "ipaddress",
- "required": false,
- "type": "string"
- },
- {
- "description": "the Pod ID for the host",
- "length": 255,
- "name": "podid",
- "related": "",
- "required": true,
- "type": "uuid"
- },
- {
- "description": "list of tags to be added to the host",
- "length": 255,
- "name": "hosttags",
- "required": false,
- "type": "list"
- },
- {
- "description": "the username for the host; required to be passed for hypervisors other than VMWare",
- "length": 255,
- "name": "username",
- "required": false,
- "type": "string"
- },
- {
"description": "the cluster name for the host",
"length": 255,
"name": "clustername",
@@ -112009,6 +113649,20 @@
"type": "uuid"
},
{
+ "description": "ip address intentionally allocated to this host after provisioning",
+ "length": 255,
+ "name": "ipaddress",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the host URL",
+ "length": 255,
+ "name": "url",
+ "required": true,
+ "type": "string"
+ },
+ {
"description": "the Zone ID for the host",
"length": 255,
"name": "zoneid",
@@ -112017,121 +113671,87 @@
"type": "uuid"
},
{
- "description": "the host URL",
+ "description": "the password for the host; required to be passed for hypervisors other than VMWare",
"length": 255,
- "name": "url",
+ "name": "password",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "list of tags to be added to the host",
+ "length": 255,
+ "name": "hosttags",
+ "required": false,
+ "type": "list"
+ },
+ {
+ "description": "the username for the host; required to be passed for hypervisors other than VMWare",
+ "length": 255,
+ "name": "username",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "Allocation state of this Host for allocation of new resources",
+ "length": 255,
+ "name": "allocationstate",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "hypervisor type of the host",
+ "length": 255,
+ "name": "hypervisor",
"required": true,
"type": "string"
+ },
+ {
+ "description": "the Pod ID for the host",
+ "length": 255,
+ "name": "podid",
+ "related": "",
+ "required": true,
+ "type": "uuid"
}
],
"related": "",
"response": [
{
- "description": "the amount of the host's memory currently allocated in bytes",
- "name": "memoryallocatedbytes",
+ "description": "the IP address of the host",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "the CPU speed of the host",
+ "name": "cpuspeed",
"type": "long"
},
{
- "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise",
- "name": "suitableformigration",
- "type": "boolean"
+ "description": "the host's currently allocated disk size",
+ "name": "disksizeallocated",
+ "type": "long"
},
{
- "description": "comma-separated list of tags for the host",
- "name": "hosttags",
+ "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor",
+ "name": "cpuallocatedwithoverprovisioning",
"type": "string"
},
{
+ "description": "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 OS category ID of the host",
"name": "oscategoryid",
"type": "string"
},
{
- "description": "the amount of the host's memory currently used",
- "name": "memoryused",
- "type": "long"
- },
- {
- "description": "the Zone name of the host",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "the cpu average load on the host",
- "name": "cpuloadaverage",
- "type": "double"
- },
- {
- "description": "the management server ID of the host",
- "name": "managementserverid",
- "type": "string"
- },
- {
- "description": "the date and time the host was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the total disk size of the host",
- "name": "disksizetotal",
- "type": "long"
- },
- {
- "description": "the host HA information information",
- "name": "hostha",
- "type": "hostharesponse"
- },
- {
- "description": "the cluster ID of the host",
- "name": "clusterid",
- "type": "string"
- },
- {
- "description": "the Pod name of the host",
- "name": "podname",
- "type": "string"
- },
- {
- "description": "the Zone ID of the host",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "true if local storage is active, false otherwise",
- "name": "islocalstorageactive",
- "type": "boolean"
- },
- {
- "description": "events available for the host",
- "name": "events",
- "type": "string"
- },
- {
- "description": "the amount of the host's CPU currently allocated",
- "name": "cpuallocated",
- "type": "string"
- },
- {
- "description": "the state of the host",
- "name": "state",
- "type": "status"
- },
- {
- "description": "capabilities of the host",
- "name": "capabilities",
- "type": "string"
- },
- {
- "description": "the incoming network traffic on the host",
- "name": "networkkbsread",
- "type": "long"
- },
- {
- "description": "the host type",
- "name": "type",
- "type": "type"
- },
- {
"description": "GPU cards present in the host",
"name": "gpugroup",
"response": [
@@ -112150,23 +113770,18 @@
"type": "long"
},
{
- "description": "Maximum Y resolution per display",
- "name": "maxresolutiony",
- "type": "long"
- },
- {
- "description": "Maximum X resolution per display",
- "name": "maxresolutionx",
- "type": "long"
- },
- {
"description": "Model Name of vGPU",
"name": "vgputype",
"type": "string"
},
{
- "description": "Maximum vgpu can be created with this vgpu type on the given gpu group",
- "name": "maxcapacity",
+ "description": "Maximum 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"
},
{
@@ -112175,13 +113790,18 @@
"type": "long"
},
{
- "description": "Maximum no. of vgpu per gpu card (pgpu)",
- "name": "maxvgpuperpgpu",
+ "description": "Maximum vgpu can be created with this vgpu type on the given gpu group",
+ "name": "maxcapacity",
"type": "long"
},
{
- "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type",
- "name": "remainingcapacity",
+ "description": "Maximum X resolution per display",
+ "name": "maxresolutionx",
+ "type": "long"
+ },
+ {
+ "description": "Maximum no. of vgpu per gpu card (pgpu)",
+ "name": "maxvgpuperpgpu",
"type": "long"
}
],
@@ -112191,68 +113811,28 @@
"type": "list"
},
{
- "description": "the host hypervisor",
- "name": "hypervisor",
- "type": "hypervisortype"
- },
- {
- "description": "the number of CPU sockets on the host",
- "name": "cpusockets",
- "type": "integer"
- },
- {
- "description": "the date and time the host was removed",
- "name": "removed",
+ "description": "the last time this host was annotated",
+ "name": "lastannotated",
"type": "date"
},
{
- "description": "the resource state of the host",
- "name": "resourcestate",
- "type": "string"
- },
- {
- "description": "the last annotation set on this host by an admin",
- "name": "annotation",
- "type": "string"
- },
- {
- "description": "the amount of the host's CPU currently allocated in 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 CPU speed of the host",
- "name": "cpuspeed",
- "type": "long"
- },
- {
- "description": "the host version",
- "name": "version",
- "type": "string"
- },
- {
"description": "the Pod ID of the host",
"name": "podid",
"type": "string"
},
{
+ "description": "capabilities of the host",
+ "name": "capabilities",
+ "type": "string"
+ },
+ {
"description": "the ID of the host",
"name": "id",
"type": "string"
},
{
- "description": "the OS category name of the host",
- "name": "oscategoryname",
- "type": "string"
- },
- {
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
+ "description": "true if local storage is active, false otherwise",
+ "name": "islocalstorageactive",
"type": "boolean"
},
{
@@ -112261,39 +113841,84 @@
"type": "date"
},
{
- "description": "the amount of the host's memory currently allocated",
- "name": "memoryallocated",
+ "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise",
+ "name": "hahost",
+ "type": "boolean"
+ },
+ {
+ "description": "the host out-of-band management information",
+ "name": "outofbandmanagement",
+ "type": "outofbandmanagementresponse"
+ },
+ {
+ "description": "the admin that annotated this host",
+ "name": "username",
+ "type": "string"
+ },
+ {
+ "description": "the resource state of the host",
+ "name": "resourcestate",
+ "type": "string"
+ },
+ {
+ "description": "the Zone ID of the host",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the state of the host",
+ "name": "state",
+ "type": "status"
+ },
+ {
+ "description": "the host HA information information",
+ "name": "hostha",
+ "type": "hostharesponse"
+ },
+ {
+ "description": "comma-separated list of tags for the host",
+ "name": "hosttags",
+ "type": "string"
+ },
+ {
+ "description": "Host details in key/value pairs.",
+ "name": "details",
+ "type": "map"
+ },
+ {
+ "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning",
+ "name": "memorytotal",
"type": "long"
},
{
- "description": "the amount of the host's CPU currently used",
- "name": "cpuused",
+ "description": "the amount of the host's CPU currently allocated",
+ "name": "cpuallocated",
"type": "string"
},
{
- "description": "the outgoing network traffic on the host",
- "name": "networkkbswrite",
+ "description": "the host version",
+ "name": "version",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the host's memory currently allocated in bytes",
+ "name": "memoryallocatedbytes",
"type": "long"
},
{
- "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor",
- "name": "cpuallocatedwithoverprovisioning",
- "type": "string"
- },
- {
- "description": "the amount of the host's memory currently allocated in percentage",
- "name": "memoryallocatedpercentage",
- "type": "string"
- },
- {
"description": "the cluster name of the host",
"name": "clustername",
"type": "string"
},
{
- "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",
+ "type": "boolean"
+ },
+ {
+ "description": "the name of the host",
+ "name": "name",
+ "type": "string"
},
{
"description": "the UUID of the latest async job acting on this object",
@@ -112301,29 +113926,58 @@
"type": "string"
},
{
+ "description": "the amount of the host's CPU currently allocated in MHz",
+ "name": "cpuallocatedvalue",
+ "type": "long"
+ },
+ {
+ "description": "the cluster ID of the host",
+ "name": "clusterid",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the host's CPU currently used",
+ "name": "cpuused",
+ "type": "string"
+ },
+ {
"description": "the CPU number of the host",
"name": "cpunumber",
"type": "integer"
},
{
- "description": "Host details in key/value pairs.",
- "name": "details",
- "type": "map"
+ "description": "the amount of the host's memory currently used",
+ "name": "memoryused",
+ "type": "long"
},
- {},
+ {
+ "description": "the management server ID of the host",
+ "name": "managementserverid",
+ "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": "true if the host is disconnected. False otherwise.",
"name": "disconnected",
"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 name of the host",
- "name": "name",
+ "description": "the last annotation set on this host by an admin",
+ "name": "annotation",
"type": "string"
},
{
@@ -112332,34 +113986,33 @@
"type": "string"
},
{
- "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise",
- "name": "hahost",
+ "description": "true if this host 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 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": "the host out-of-band management information",
- "name": "outofbandmanagement",
- "type": "outofbandmanagementresponse"
+ "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor",
+ "name": "cpuwithoverprovisioning",
+ "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",
+ "type": "string"
},
{
- "description": "the IP address of the host",
- "name": "ipaddress",
+ "description": "events available for the host",
+ "name": "events",
+ "type": "string"
+ },
+ {
+ "description": "the Pod name of the host",
+ "name": "podname",
"type": "string"
},
{
@@ -112368,26 +114021,143 @@
"type": "string"
},
{
+ "description": "the host hypervisor",
+ "name": "hypervisor",
+ "type": "hypervisortype"
+ },
+ {
+ "description": "true if the host has capability to support UEFI boot",
+ "name": "ueficapability",
+ "type": "boolean"
+ },
+ {
+ "description": "the cpu average load on the host",
+ "name": "cpuloadaverage",
+ "type": "double"
+ },
+ {
+ "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": "long"
+ },
+ {
+ "description": "the Zone name of the host",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "the OS category name of the host",
+ "name": "oscategoryname",
+ "type": "string"
+ },
+ {},
+ {},
+ {
"description": "the hypervisor version",
"name": "hypervisorversion",
"type": "string"
},
{
- "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor",
- "name": "cpuwithoverprovisioning",
- "type": "string"
+ "description": "the date and time the host was removed",
+ "name": "removed",
+ "type": "date"
},
{
- "description": "the admin that annotated this host",
+ "description": "the date and time the host was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the host type",
+ "name": "type",
+ "type": "type"
+ }
+ ]
+ },
+ {
+ "description": "remove an annotation.",
+ "isasync": false,
+ "name": "removeAnnotation",
+ "params": [
+ {
+ "description": "the id of the annotation",
+ "length": 255,
+ "name": "id",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "related": "",
+ "response": [
+ {
+ "description": "the (uu)id of the annotation",
+ "name": "id",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "The username of the user that entered the annotation",
"name": "username",
"type": "string"
},
+ {},
{
- "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning",
- "name": "memorytotal",
- "type": "long"
+ "description": "the contents of the annotation",
+ "name": "annotation",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "True if the annotation is available for admins only",
+ "name": "adminsonly",
+ "type": "boolean"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the (uu)id of the entitiy to which this annotation pertains",
+ "name": "entityid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the entitiy to which this annotation pertains",
+ "name": "entityname",
+ "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 user that entered the annotation",
+ "name": "userid",
+ "type": "string"
+ },
+ {
+ "description": "the type of the annotated entity",
+ "name": "entitytype",
+ "type": "string"
}
- ]
+ ],
+ "since": "4.11"
},
{
"description": "Deletes a project role permission in the project",
@@ -112412,28 +114182,28 @@
}
],
"response": [
+ {},
{
"description": "any text associated with the success or failure",
"name": "displaytext",
"type": "string"
},
+ {},
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {},
- {
"description": "true if operation is executed successfully",
"name": "success",
"type": "boolean"
- },
- {}
+ }
],
"since": "4.15.0"
},
@@ -112452,27 +114222,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": "the 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.9.0"
@@ -112498,21 +114268,21 @@
},
{},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
+ "description": "true if operation is executed successfully",
+ "name": "success",
+ "type": "boolean"
},
{
"description": "any text associated with the success or failure",
"name": "displaytext",
"type": "string"
},
+ {},
{
- "description": "true if operation is executed successfully",
- "name": "success",
- "type": "boolean"
- },
- {}
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ }
]
},
{
@@ -112528,6 +114298,29 @@
"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 zone(s) as comma separated string, all for all zones offerings",
+ "length": 255,
+ "name": "zoneid",
+ "required": false,
+ "since": "4.13",
+ "type": "string"
+ },
+ {
+ "description": "sort key of the VPC offering, integer",
+ "length": 255,
+ "name": "sortkey",
+ "required": false,
+ "type": "integer"
+ },
+ {
"description": "update state for the VPC offering; supported states - Enabled/Disabled",
"length": 255,
"name": "state",
@@ -112542,29 +114335,6 @@
"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,
- "name": "sortkey",
- "required": false,
- "type": "integer"
- },
- {
- "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings",
- "length": 255,
- "name": "zoneid",
- "required": false,
- "since": "4.13",
- "type": "string"
- },
- {
"description": "the display text of the VPC offering",
"length": 255,
"name": "displaytext",
@@ -112575,8 +114345,13 @@
"related": "",
"response": [
{
- "description": "the id of the vpc offering",
- "name": "id",
+ "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
+ "name": "zone",
+ "type": "string"
+ },
+ {
+ "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
+ "name": "zoneid",
"type": "string"
},
{},
@@ -112585,51 +114360,81 @@
"name": "name",
"type": "string"
},
- {},
- {
- "description": " indicates if the vpc offering supports distributed router for one-hop forwarding",
- "name": "distributedvpcrouter",
- "type": "boolean"
- },
{
"description": "state of the vpc offering. Can be Disabled/Enabled",
"name": "state",
"type": "string"
},
{
- "description": "the 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",
- "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 domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
"name": "domain",
"type": "string"
},
{
+ "description": "an alternate display text of the vpc offering.",
+ "name": "displaytext",
+ "type": "string"
+ },
+ {
+ "description": "the date this vpc offering was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": " indicates if the vpc offering supports distributed router for one-hop forwarding",
+ "name": "distributedvpcrouter",
+ "type": "boolean"
+ },
+ {
+ "description": "the id of the vpc offering",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": " indicated if the offering can support region level vpc",
+ "name": "supportsregionLevelvpc",
+ "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 UUID of the latest async job acting on 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 vpc offering is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {
"description": "the list of supported services",
"name": "service",
"response": [
{
+ "description": "the service name",
+ "name": "name",
+ "type": "string"
+ },
+ {
"description": "the list of capabilities",
"name": "capability",
"response": [
{
+ "description": "the capability value",
+ "name": "value",
+ "type": "string"
+ },
+ {
"description": "the capability name",
"name": "name",
"type": "string"
@@ -112638,11 +114443,6 @@
"description": "can this service capability value can be choosable while creatine network offerings",
"name": "canchooseservicecapability",
"type": "boolean"
- },
- {
- "description": "the capability value",
- "name": "value",
- "type": "string"
}
],
"type": "list"
@@ -112652,13 +114452,28 @@
"name": "provider",
"response": [
{
- "description": "state of the network provider",
- "name": "state",
+ "description": "the destination physical network",
+ "name": "destinationphysicalnetworkid",
"type": "string"
},
{
- "description": "the physical network this belongs to",
- "name": "physicalnetworkid",
+ "description": "uuid of the network provider",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "true if individual services can be enabled/disabled",
+ "name": "canenableindividualservice",
+ "type": "boolean"
+ },
+ {
+ "description": "services for this provider",
+ "name": "servicelist",
+ "type": "list"
+ },
+ {
+ "description": "state of the network provider",
+ "name": "state",
"type": "string"
},
{
@@ -112667,60 +114482,15 @@
"type": "string"
},
{
- "description": "the destination physical network",
- "name": "destinationphysicalnetworkid",
- "type": "string"
- },
- {
- "description": "services for this provider",
- "name": "servicelist",
- "type": "list"
- },
- {
- "description": "true if individual services can be enabled/disabled",
- "name": "canenableindividualservice",
- "type": "boolean"
- },
- {
- "description": "uuid of the network provider",
- "name": "id",
+ "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 date this vpc 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": " indicated if the offering can support region level vpc",
- "name": "supportsregionLevelvpc",
- "type": "boolean"
- },
- {
- "description": "true if vpc offering is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
- },
- {
- "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
- "name": "zoneid",
- "type": "string"
}
]
},
@@ -112730,6 +114500,14 @@
"name": "updateRemoteAccessVpn",
"params": [
{
+ "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only",
+ "length": 255,
+ "name": "customid",
+ "required": false,
+ "since": "4.4",
+ "type": "string"
+ },
+ {
"description": "an optional field, whether to the display the vpn to the end user or not",
"length": 255,
"name": "fordisplay",
@@ -112744,89 +114522,81 @@
"related": "updateRemoteAccessVpn",
"required": true,
"type": "uuid"
- },
- {
- "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only",
- "length": 255,
- "name": "customid",
- "required": false,
- "since": "4.4",
- "type": "string"
}
],
"related": "",
"response": [
{
- "description": "the state of the rule",
- "name": "state",
- "type": "string"
- },
- {
- "description": "the project name of the vpn",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the ipsec preshared key",
- "name": "presharedkey",
- "type": "string"
- },
- {
- "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": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
"description": "the public ip address of the vpn server",
"name": "publicipid",
"type": "string"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {},
- {
"description": "the domain name of the account of the remote access vpn",
"name": "domain",
"type": "string"
},
{
- "description": "the account of the remote access vpn",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the domain id of the account of the remote access vpn",
- "name": "domainid",
- "type": "string"
- },
- {
"description": "the id of the remote access vpn",
"name": "id",
"type": "string"
},
+ {},
+ {
+ "description": "is vpn for display to the regular user",
+ "name": "fordisplay",
+ "type": "boolean"
+ },
+ {
+ "description": "the account of the remote access vpn",
+ "name": "account",
+ "type": "string"
+ },
{
"description": "the public ip address of the vpn server",
"name": "publicip",
"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 domain id of the account of the remote access vpn",
+ "name": "domainid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the project name of the vpn",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "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": "the ipsec preshared key",
+ "name": "presharedkey",
+ "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"
}
],
"since": "4.4"
@@ -112837,11 +114607,12 @@
"name": "scaleVirtualMachine",
"params": [
{
- "description": "name value pairs of custom parameters for cpu,memory and cpunumber. example details[i].name=value",
+ "description": "The ID of the virtual machine",
"length": 255,
- "name": "details",
- "required": false,
- "type": "map"
+ "name": "id",
+ "related": "destroyVirtualMachine,scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines",
+ "required": true,
+ "type": "uuid"
},
{
"description": "the ID of the service offering for the virtual machine",
@@ -112852,37 +114623,36 @@
"type": "uuid"
},
{
- "description": "The ID of the virtual machine",
+ "description": "name value pairs of custom parameters for cpu,memory and cpunumber. example details[i].name=value",
"length": 255,
- "name": "id",
- "related": "destroyVirtualMachine,scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines",
- "required": true,
- "type": "uuid"
+ "name": "details",
+ "required": false,
+ "type": "map"
}
],
"response": [
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
"description": "any text associated 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"
- },
- {}
+ }
]
},
{
@@ -112891,12 +114661,12 @@
"name": "destroyVirtualMachine",
"params": [
{
- "description": "If true is passed, the vm is expunged immediately. False by default.",
+ "description": "The ID of the virtual machine",
"length": 255,
- "name": "expunge",
- "required": false,
- "since": "4.2.1",
- "type": "boolean"
+ "name": "id",
+ "related": "destroyVirtualMachine,scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines",
+ "required": true,
+ "type": "uuid"
},
{
"description": "Comma separated list of UUIDs for volumes that will be deleted",
@@ -112908,367 +114678,19 @@
"type": "list"
},
{
- "description": "The ID of the virtual machine",
+ "description": "If true is passed, the vm is expunged immediately. False by default.",
"length": 255,
- "name": "id",
- "related": "destroyVirtualMachine,scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines",
- "required": true,
- "type": "uuid"
+ "name": "expunge",
+ "required": false,
+ "since": "4.2.1",
+ "type": "boolean"
}
],
"related": "scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines",
"response": [
- {},
{
- "description": "Guest vm Boot Mode",
- "name": "bootmode",
- "type": "string"
- },
- {
- "description": "device ID of the root volume",
- "name": "rootdeviceid",
- "type": "long"
- },
- {
- "description": "the password (if exists) of the virtual machine",
- "name": "password",
- "type": "string"
- },
- {
- "description": "the amount of the vm's CPU currently used",
- "name": "cpuused",
- "type": "string"
- },
- {
- "description": "the name of the domain in which the virtual machine exists",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the read (bytes) of disk on the vm",
- "name": "diskkbsread",
- "type": "long"
- },
- {
- "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": "the name of the host for the virtual machine",
- "name": "hostname",
- "type": "string"
- },
- {
- "description": "the date when this virtual machine was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the user's name who deployed the virtual machine",
- "name": "username",
- "type": "string"
- },
- {
- "description": "the name of the ISO attached to the virtual machine",
- "name": "isoname",
- "type": "string"
- },
- {
- "description": "the ID of the backup offering of the virtual machine",
- "name": "backupofferingid",
- "type": "string"
- },
- {
- "description": "the pool type of the virtual machine",
- "name": "pooltype",
- "type": "string"
- },
- {
- "description": "user generated name. The name of the virtual machine is returned if no displayname exists.",
- "name": "displayname",
- "type": "string"
- },
- {
- "description": "the number of cpu this virtual machine is running with",
- "name": "cpunumber",
- "type": "integer"
- },
- {
- "description": "an alternate display text of the ISO attached to the virtual machine",
- "name": "isodisplaytext",
- "type": "string"
- },
- {
- "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": "State of the Service from LB rule",
- "name": "servicestate",
- "type": "string"
- },
- {
- "description": "the virtual network for the service offering",
- "name": "forvirtualnetwork",
- "type": "boolean"
- },
- {
- "description": "the ID of the host for the virtual machine",
- "name": "hostid",
- "type": "string"
- },
- {
- "description": "the name of the service offering of the virtual machine",
- "name": "serviceofferingname",
- "type": "string"
- },
- {
- "description": "the state of the virtual machine",
- "name": "state",
- "type": "string"
- },
- {
- "description": "device type of the root volume",
- "name": "rootdevicetype",
- "type": "string"
- },
- {
- "description": "the memory allocated for the virtual machine",
- "name": "memory",
- "type": "integer"
- },
- {
- "description": "the memory used by the vm",
- "name": "memorykbs",
- "type": "long"
- },
- {
- "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 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": "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",
- "type": "string"
- },
- {
- "description": "the user's ID who deployed the virtual machine",
- "name": "userid",
- "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 internal memory that's free in vm or zero if it can not be calculated",
- "name": "memoryintfreekbs",
- "type": "long"
- },
- {
- "description": "the write (bytes) of disk on the vm",
- "name": "diskkbswrite",
- "type": "long"
- },
- {
- "description": "ssh key-pair",
- "name": "keypair",
- "type": "string"
- },
- {
- "description": "Vm details in key/value pairs.",
- "name": "details",
- "type": "map"
- },
- {
- "description": "the ID of the domain in which the virtual machine exists",
- "name": "domainid",
- "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": "the list of nics associated with vm",
- "name": "nic",
- "response": [
- {
- "description": "the ip address of the nic",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "description": "the extra dhcp options on the nic",
- "name": "extradhcpoption",
- "type": "list"
- },
- {
- "description": "Id of the 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": "the IPv6 address of network",
- "name": "ip6address",
- "type": "string"
- },
- {
- "description": "the name of the corresponding network",
- "name": "networkname",
- "type": "string"
- },
- {
- "description": "the traffic type of the nic",
- "name": "traffictype",
- "type": "string"
- },
- {
- "description": "Type of adapter if available",
- "name": "adaptertype",
- "type": "string"
- },
- {
- "description": "Id of the vm to which the nic belongs",
- "name": "virtualmachineid",
- "type": "string"
- },
- {
- "description": "the cidr of IPv6 network",
- "name": "ip6cidr",
- "type": "string"
- },
- {
- "description": "true if nic is default, false otherwise",
- "name": "macaddress",
- "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 broadcast uri of the nic",
- "name": "broadcasturi",
- "type": "string"
- },
- {
- "description": "true if nic is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
- },
- {
- "description": "the isolated private VLAN if available",
- "name": "isolatedpvlan",
- "type": "integer"
- },
- {
- "description": "the isolation uri of the nic",
- "name": "isolationuri",
- "type": "string"
- },
- {
- "description": "the gateway of IPv6 network",
- "name": "ip6gateway",
- "type": "string"
- },
- {
- "description": "the Secondary ipv4 addr of nic",
- "name": "secondaryip",
- "type": "list"
- },
- {
- "description": "the isolated private VLAN type if available",
- "name": "isolatedpvlantype",
- "type": "string"
- },
- {
- "description": "the ID of the corresponding network",
- "name": "networkid",
- "type": "string"
- },
- {
- "description": "the ID of the nic",
- "name": "id",
- "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 type of the nic",
- "name": "type",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the project name of the vm",
- "name": "project",
+ "description": "instance name of the user vm; this parameter is returned to the ROOT admin only",
+ "name": "instancename",
"type": "string"
},
{
@@ -113277,9 +114699,14 @@
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "the memory used by the vm",
+ "name": "memorykbs",
+ "type": "long"
+ },
+ {
+ "description": "the name of the template for the virtual machine",
+ "name": "templatename",
+ "type": "string"
},
{
"description": "the incoming network traffic on the vm",
@@ -113287,95 +114714,14 @@
"type": "long"
},
{
- "description": "the project id of the vm",
- "name": "projectid",
+ "description": "the ID of the host for the virtual machine",
+ "name": "hostid",
"type": "string"
},
{
- "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.",
- "name": "isdynamicallyscalable",
- "type": "boolean"
- },
- {
- "description": "the outgoing network traffic on the host",
- "name": "networkkbswrite",
- "type": "long"
- },
- {
- "description": "List of read-only Vm details as comma separated string.",
- "name": "readonlydetails",
- "type": "string"
- },
- {
- "description": "the ID of the availablility zone for the virtual machine",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the account associated with the virtual machine",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the group ID of the virtual machine",
- "name": "groupid",
- "type": "string"
- },
- {
- "description": "the ID of the service offering of the virtual machine",
- "name": "serviceofferingid",
- "type": "string"
- },
- {},
- {
- "description": "the name of the backup offering of the virtual machine",
- "name": "backupofferingname",
- "type": "string"
- },
- {
- "description": "the ID of the disk offering of the virtual machine",
- "name": "diskofferingid",
- "type": "string"
- },
- {
- "description": "instance name of the user vm; this parameter is returned to the ROOT admin only",
- "name": "instancename",
- "type": "string"
- },
- {
- "description": "the target memory in vm",
- "name": "memorytargetkbs",
- "type": "long"
- },
- {
- "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": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
- },
- {
- "description": "the ID of the ISO attached to the virtual machine",
- "name": "isoid",
- "type": "string"
- },
- {
- "description": "the name of the disk offering of the virtual machine",
- "name": "diskofferingname",
- "type": "string"
- },
- {
- "description": "the name of the virtual machine",
- "name": "name",
- "type": "string"
+ "description": "the date when this virtual machine was updated last time",
+ "name": "lastupdated",
+ "type": "date"
},
{
"description": "Os type ID of the virtual machine",
@@ -113383,27 +114729,130 @@
"type": "string"
},
{
- "description": "the write (io) of disk on the vm",
- "name": "diskiowrite",
+ "description": "public IP address id associated with vm via Static nat rule",
+ "name": "publicip",
+ "type": "string"
+ },
+ {
+ "description": "Vm details in key/value pairs.",
+ "name": "details",
+ "type": "map"
+ },
+ {
+ "description": "the name of the backup offering of the virtual machine",
+ "name": "backupofferingname",
+ "type": "string"
+ },
+ {
+ "description": "OS type id of the vm",
+ "name": "ostypeid",
+ "type": "string"
+ },
+ {
+ "description": "the total number of network traffic bytes sent",
+ "name": "sentbytes",
"type": "long"
},
{
+ "description": "the ID of the service offering of the virtual machine",
+ "name": "serviceofferingid",
+ "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": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "State of the Service from LB rule",
+ "name": "servicestate",
+ "type": "string"
+ },
+ {
+ "description": "true if high-availability is enabled, false otherwise",
+ "name": "haenable",
+ "type": "boolean"
+ },
+ {
+ "description": "the name of the ISO attached to the virtual machine",
+ "name": "isoname",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the ID of the domain in which the virtual machine exists",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the name of the availability zone for the virtual machine",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
"description": "list of affinity groups associated with the virtual machine",
"name": "affinitygroup",
"response": [
{
- "description": "the 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",
+ "description": "the name of the affinity group",
+ "name": "name",
"type": "string"
},
{
@@ -113412,13 +114861,28 @@
"type": "string"
},
{
+ "description": "the description of the affinity group",
+ "name": "description",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID of the affinity group",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
"description": "the project ID of the affinity group",
"name": "projectid",
"type": "string"
},
{
- "description": "the domain name of the affinity group",
- "name": "domain",
+ "description": "the account owning the affinity group",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the affinity group",
+ "name": "project",
"type": "string"
},
{
@@ -113432,158 +114896,64 @@
"type": "string"
},
{
- "description": "the name of the affinity group",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the description of the affinity group",
- "name": "description",
+ "description": "the domain name of the affinity group",
+ "name": "domain",
"type": "string"
}
],
"type": "set"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the user's name who deployed the virtual machine",
+ "name": "username",
"type": "string"
},
{
- "description": "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 total number of network traffic bytes sent",
- "name": "sentbytes",
+ "description": "the write (io) of disk on the vm",
+ "name": "diskiowrite",
"type": "long"
},
{
+ "description": "the name of the service offering of the virtual machine",
+ "name": "serviceofferingname",
+ "type": "string"
+ },
+ {
"description": "list of security groups associated with the virtual machine",
"name": "securitygroup",
"response": [
{
- "description": "the list of ingress rules associated with the security group",
- "name": "ingressrule",
- "response": [
- {
- "description": "the type of the ICMP message response",
- "name": "icmptype",
- "type": "integer"
- },
- {
- "description": "the ending IP of the security group rule ",
- "name": "endport",
- "type": "integer"
- },
- {
- "description": "the code for the ICMP message response",
- "name": "icmpcode",
- "type": "integer"
- },
- {
- "description": "security group name",
- "name": "securitygroupname",
- "type": "string"
- },
- {
- "description": "the starting IP of the security group rule",
- "name": "startport",
- "type": "integer"
- },
- {
- "description": "the CIDR notation for the base IP address of the security group rule",
- "name": "cidr",
- "type": "string"
- },
- {
- "description": "the protocol of the security group rule",
- "name": "protocol",
- "type": "string"
- },
- {
- "description": "the list of resource tags associated with the rule",
- "name": "tags",
- "response": [
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the 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 value",
- "name": "value",
- "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"
- }
- ],
- "type": "set"
+ "description": "the account owning the security group",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the domain name of the security group",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the security group",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the group",
+ "name": "project",
+ "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 id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
"type": "string"
},
{
@@ -113592,26 +114962,16 @@
"type": "string"
},
{
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
"description": "the domain associated with the tag",
"name": "domain",
"type": "string"
},
{
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
"description": "the account associated with the tag",
"name": "account",
"type": "string"
@@ -113622,14 +114982,138 @@
"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": "customer associated with the tag",
+ "name": "customer",
"type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the name of the security group",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the description of the security group",
+ "name": "description",
+ "type": "string"
+ },
+ {
+ "description": "the list of ingress rules associated with the security group",
+ "name": "ingressrule",
+ "response": [
+ {
+ "description": "the type of the ICMP message response",
+ "name": "icmptype",
+ "type": "integer"
+ },
+ {
+ "description": "security group name",
+ "name": "securitygroupname",
+ "type": "string"
+ },
+ {
+ "description": "the id of the security group rule",
+ "name": "ruleid",
+ "type": "string"
+ },
+ {
+ "description": "the protocol of the security group rule",
+ "name": "protocol",
+ "type": "string"
+ },
+ {
+ "description": "account owning the security group rule",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the list of resource tags associated with the rule",
+ "name": "tags",
+ "response": [
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "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 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": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ }
+ ],
+ "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": "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"
@@ -113639,93 +115123,11 @@
"name": "egressrule",
"response": [
{
- "description": "the type of the ICMP message response",
- "name": "icmptype",
- "type": "integer"
- },
- {
- "description": "account owning the security group rule",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the 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 list of resource tags associated with the rule",
- "name": "tags",
- "response": [
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "the 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": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the id of the security group rule",
- "name": "ruleid",
- "type": "string"
- },
- {
"description": "the starting IP of the security group rule",
"name": "startport",
"type": "integer"
@@ -113736,27 +115138,99 @@
"type": "integer"
},
{
+ "description": "the id of the security group rule",
+ "name": "ruleid",
+ "type": "string"
+ },
+ {
+ "description": "the protocol of the security group rule",
+ "name": "protocol",
+ "type": "string"
+ },
+ {
+ "description": "the code for the ICMP message response",
+ "name": "icmpcode",
+ "type": "integer"
+ },
+ {
+ "description": "account owning the security group rule",
+ "name": "account",
+ "type": "string"
+ },
+ {
"description": "the CIDR notation for the base IP address of the security group rule",
"name": "cidr",
"type": "string"
+ },
+ {
+ "description": "the type of the ICMP message response",
+ "name": "icmptype",
+ "type": "integer"
+ },
+ {
+ "description": "the list of resource tags associated with the rule",
+ "name": "tags",
+ "response": [
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "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": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ }
+ ],
+ "type": "set"
}
],
"type": "set"
},
{
- "description": "the domain name of the security group",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the description of the security group",
- "name": "description",
- "type": "string"
- },
- {
- "description": "the project name of the group",
- "name": "project",
- "type": "string"
+ "description": "the number of virtualmachines associated with this securitygroup",
+ "name": "virtualmachinecount",
+ "type": "integer"
},
{
"description": "the project id of the group",
@@ -113764,11 +115238,6 @@
"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"
@@ -113777,97 +115246,398 @@
"description": "the domain ID of the security group",
"name": "domainid",
"type": "string"
- },
- {
- "description": "the ID of the security group",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the account owning the security group",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the number of virtualmachines associated with this securitygroup",
- "name": "virtualmachinecount",
- "type": "integer"
}
],
"type": "set"
},
{
+ "description": "the name of the disk offering of the virtual machine",
+ "name": "diskofferingname",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the virtual machine",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "user generated name. The name of the virtual machine is returned if no displayname exists.",
+ "name": "displayname",
+ "type": "string"
+ },
+ {
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "description": "the read (io) of disk on the vm",
+ "name": "diskioread",
+ "type": "long"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the pool type of the virtual machine",
+ "name": "pooltype",
+ "type": "string"
+ },
+ {
+ "description": "the number of cpu this virtual machine is running with",
+ "name": "cpunumber",
+ "type": "integer"
+ },
+ {
+ "description": "the memory allocated for the virtual machine",
+ "name": "memory",
+ "type": "integer"
+ },
+ {
+ "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": "the outgoing network traffic on the host",
+ "name": "networkkbswrite",
+ "type": "long"
+ },
+ {
+ "description": "Guest vm Boot Mode",
+ "name": "bootmode",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the vm",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "ssh key-pair",
+ "name": "keypair",
+ "type": "string"
+ },
+ {
+ "description": "the read (bytes) of disk on the vm",
+ "name": "diskkbsread",
+ "type": "long"
+ },
+ {
+ "description": "the hypervisor on which the template runs",
+ "name": "hypervisor",
+ "type": "string"
+ },
+ {
+ "description": "device type of the root volume",
+ "name": "rootdevicetype",
+ "type": "string"
+ },
+ {
+ "description": "the vgpu type used by the virtual machine",
+ "name": "vgpu",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the host for the virtual machine",
+ "name": "hostname",
+ "type": "string"
+ },
+ {
+ "description": "the write (bytes) of disk on the vm",
+ "name": "diskkbswrite",
+ "type": "long"
+ },
+ {
+ "description": " an alternate display text of the template for the virtual machine",
+ "name": "templatedisplaytext",
+ "type": "string"
+ },
+ {
+ "description": "the name of the virtual machine",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the internal memory that's free in vm or zero if it can not be calculated",
+ "name": "memoryintfreekbs",
+ "type": "long"
+ },
+ {
+ "description": "the password (if exists) of the virtual machine",
+ "name": "password",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the vm's CPU currently used",
+ "name": "cpuused",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the availablility 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": "an alternate display text of the ISO attached to the virtual machine",
+ "name": "isodisplaytext",
+ "type": "string"
+ },
+ {
+ "description": "List of read-only Vm details as comma separated string.",
+ "name": "readonlydetails",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the virtual machine",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the backup offering of the virtual machine",
+ "name": "backupofferingid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the disk offering of the virtual machine",
+ "name": "diskofferingid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the virtual network for the service offering",
+ "name": "forvirtualnetwork",
+ "type": "boolean"
+ },
+ {
+ "description": "the user's ID who deployed the virtual machine",
+ "name": "userid",
+ "type": "string"
+ },
+ {
+ "description": "the 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 project id of the vm",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
"description": "true if the password rest feature is enabled, false otherwise",
"name": "passwordenabled",
"type": "boolean"
},
- {},
+ {
+ "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.",
+ "name": "templateid",
+ "type": "string"
+ },
+ {
+ "description": "OS name of the vm",
+ "name": "osdisplayname",
+ "type": "string"
+ },
+ {
+ "description": "the group ID of the virtual machine",
+ "name": "groupid",
+ "type": "string"
+ },
{
"description": "the speed of each cpu",
"name": "cpuspeed",
"type": "integer"
},
{
- "description": "the name of the availability zone for the virtual machine",
- "name": "zonename",
+ "description": "the name of the domain in which the virtual machine exists",
+ "name": "domain",
"type": "string"
},
{
- "description": "the list of resource tags associated",
- "name": "tags",
+ "description": "the list of nics associated with vm",
+ "name": "nic",
"response": [
{
- "description": "tag value",
- "name": "value",
+ "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": "tag key name",
- "name": "key",
+ "description": "the netmask of the nic",
+ "name": "netmask",
"type": "string"
},
{
- "description": "the account associated with the tag",
- "name": "account",
+ "description": "the IPv6 address of network",
+ "name": "ip6address",
"type": "string"
},
{
- "description": "the project name where tag belongs to",
- "name": "project",
+ "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 domain associated with the tag",
- "name": "domain",
+ "description": "the type of the nic",
+ "name": "type",
"type": "string"
},
{
- "description": "customer associated with the tag",
- "name": "customer",
+ "description": "ID of the VLAN/VNI if available",
+ "name": "vlanid",
+ "type": "integer"
+ },
+ {
+ "description": "the ID of the corresponding network",
+ "name": "networkid",
"type": "string"
},
{
- "description": "the project id the tag belongs to",
- "name": "projectid",
+ "description": "the ip address of the nic",
+ "name": "ipaddress",
"type": "string"
},
{
- "description": "resource type",
- "name": "resourcetype",
+ "description": "the cidr of IPv6 network",
+ "name": "ip6cidr",
"type": "string"
},
{
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
+ "description": "the gateway of IPv6 network",
+ "name": "ip6gateway",
"type": "string"
},
{
- "description": "id of the resource",
- "name": "resourceid",
+ "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise",
+ "name": "nsxlogicalswitchport",
"type": "string"
+ },
+ {
+ "description": "the name of the corresponding network",
+ "name": "networkname",
+ "type": "string"
+ },
+ {
+ "description": "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": "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": "the broadcast uri of the nic",
+ "name": "broadcasturi",
+ "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 isolation uri of the nic",
+ "name": "isolationuri",
+ "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 traffic type of the nic",
+ "name": "traffictype",
+ "type": "string"
+ },
+ {
+ "description": "the extra dhcp options on the nic",
+ "name": "extradhcpoption",
+ "type": "list"
}
],
"type": "set"
+ },
+ {
+ "description": "the total number of network traffic bytes received",
+ "name": "receivedbytes",
+ "type": "long"
+ },
+ {
+ "description": "the ID of the ISO attached to the virtual machine",
+ "name": "isoid",
+ "type": "string"
+ },
+ {
+ "description": "the state of the virtual machine",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "the target memory in vm",
+ "name": "memorytargetkbs",
+ "type": "long"
+ },
+ {
+ "description": "Guest vm Boot Type",
+ "name": "boottype",
+ "type": "string"
}
]
},
@@ -113904,28 +115674,8 @@
"related": "",
"response": [
{
- "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 cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).",
- "name": "cidrlist",
- "type": "string"
- },
- {
- "description": "is rule for display to the regular user",
- "name": "fordisplay",
- "type": "boolean"
- },
- {
- "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).",
- "name": "destcidrlist",
+ "description": "the network id of the firewall rule",
+ "name": "networkid",
"type": "string"
},
{
@@ -113934,34 +115684,13 @@
"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 state of the rule",
- "name": "state",
- "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 ending port of firewall rule's port range",
- "name": "endport",
- "type": "integer"
- },
- {},
- {
- "description": "the network id of the firewall rule",
- "name": "networkid",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
@@ -113969,26 +115698,6 @@
"name": "tags",
"response": [
{
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
"description": "id of the resource",
"name": "resourceid",
"type": "string"
@@ -113999,6 +115708,21 @@
"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": "customer associated with the tag",
"name": "customer",
"type": "string"
@@ -114014,28 +115738,74 @@
"type": "string"
},
{
- "description": "resource type",
- "name": "resourcetype",
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
"type": "string"
}
],
"type": "list"
},
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the public ip address id for the firewall rule",
+ "name": "ipaddressid",
+ "type": "string"
+ },
+ {
+ "description": "the public ip address for the firewall rule",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "type of the icmp message being sent",
+ "name": "icmptype",
+ "type": "integer"
+ },
+ {
+ "description": "the 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 state of the rule",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "is rule for display to the regular user",
+ "name": "fordisplay",
+ "type": "boolean"
+ },
+ {},
+ {
+ "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).",
+ "name": "cidrlist",
+ "type": "string"
+ },
+ {
"description": "the ID of the firewall rule",
"name": "id",
"type": "string"
},
{
- "description": "error code for this icmp message",
- "name": "icmpcode",
- "type": "integer"
- },
- {
- "description": "type of the icmp message being sent",
- "name": "icmptype",
- "type": "integer"
+ "description": "the protocol of the firewall rule",
+ "name": "protocol",
+ "type": "string"
}
],
"since": "4.4"
@@ -114048,11 +115818,26 @@
{
"description": "",
"length": 255,
- "name": "page",
+ "name": "pagesize",
"required": false,
"type": "integer"
},
{
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "list Os category by id",
+ "length": 255,
+ "name": "id",
+ "related": "listOsCategories",
+ "required": false,
+ "type": "uuid"
+ },
+ {
"description": "list os category by name",
"length": 255,
"name": "name",
@@ -114063,38 +115848,13 @@
{
"description": "",
"length": 255,
- "name": "pagesize",
+ "name": "page",
"required": false,
"type": "integer"
- },
- {
- "description": "list Os category by id",
- "length": 255,
- "name": "id",
- "related": "listOsCategories",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
}
],
"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",
- "type": "string"
- },
{},
{},
{
@@ -114106,6 +115866,16 @@
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
+ },
+ {
+ "description": "the name of the OS category",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
}
]
},
@@ -114115,11 +115885,34 @@
"name": "listServiceOfferings",
"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",
+ "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": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "the CPU speed that listed offerings must support",
+ "length": 255,
+ "name": "cpuspeed",
+ "required": false,
+ "since": "4.15",
+ "type": "integer"
+ },
+ {
+ "description": "the system VM type. Possible types are \"consoleproxy\", \"secondarystoragevm\" or \"domainrouter\".",
+ "length": 255,
+ "name": "systemvmtype",
+ "required": false,
+ "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.",
@@ -114130,6 +115923,14 @@
"type": "uuid"
},
{
+ "description": "list only resources belonging to the domain specified",
+ "length": 255,
+ "name": "domainid",
+ "related": "listDomains",
+ "required": false,
+ "type": "uuid"
+ },
+ {
"description": "id of zone disk offering is associated with",
"length": 255,
"name": "zoneid",
@@ -114139,42 +115940,13 @@
"type": "uuid"
},
{
- "description": "the CPU number that listed offerings must support",
+ "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false",
"length": 255,
- "name": "cpunumber",
- "required": false,
- "since": "4.15",
- "type": "integer"
- },
- {
- "description": "is this a system vm offering",
- "length": 255,
- "name": "issystem",
+ "name": "listall",
"required": false,
"type": "boolean"
},
{
- "description": "the system VM type. Possible types are \"consoleproxy\", \"secondarystoragevm\" or \"domainrouter\".",
- "length": 255,
- "name": "systemvmtype",
- "required": false,
- "type": "string"
- },
- {
- "description": "",
- "length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
- },
- {
- "description": "name of the service offering",
- "length": 255,
- "name": "name",
- "required": false,
- "type": "string"
- },
- {
"description": "List by keyword",
"length": 255,
"name": "keyword",
@@ -114182,12 +115954,18 @@
"type": "string"
},
{
- "description": "list only resources belonging to the domain specified",
+ "description": "is this a system vm offering",
"length": 255,
- "name": "domainid",
- "related": "listDomains",
+ "name": "issystem",
"required": false,
- "type": "uuid"
+ "type": "boolean"
+ },
+ {
+ "description": "name of the service offering",
+ "length": 255,
+ "name": "name",
+ "required": false,
+ "type": "string"
},
{
"description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
@@ -114197,6 +115975,14 @@
"type": "boolean"
},
{
+ "description": "the RAM memory that listed offering must support",
+ "length": 255,
+ "name": "memory",
+ "required": false,
+ "since": "4.15",
+ "type": "integer"
+ },
+ {
"description": "ID of the service offering",
"length": 255,
"name": "id",
@@ -114210,171 +115996,88 @@
"name": "page",
"required": false,
"type": "integer"
- },
- {
- "description": "the CPU speed that listed offerings must support",
- "length": 255,
- "name": "cpuspeed",
- "required": false,
- "since": "4.15",
- "type": "integer"
- },
- {
- "description": "the RAM memory that listed offering must support",
- "length": 255,
- "name": "memory",
- "required": false,
- "since": "4.15",
- "type": "integer"
}
],
"related": "updateServiceOffering",
"response": [
{
- "description": "bytes write rate of the service offering",
- "name": "diskBytesWriteRate",
- "type": "long"
- },
- {
- "description": "the name of the service offering",
- "name": "name",
- "type": "string"
- },
- {
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "burst bytes read rate of the disk offering",
- "name": "diskBytesReadRateMax",
- "type": "long"
- },
- {},
- {
- "description": "Root disk size in GB",
- "name": "rootdisksize",
- "type": "long"
- },
- {
- "description": "burst bytes write rate of the disk offering",
- "name": "diskBytesWriteRateMax",
- "type": "long"
- },
- {
- "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.",
- "name": "provisioningtype",
- "type": "string"
- },
- {
- "description": "the id of the service offering",
- "name": "id",
- "type": "string"
- },
- {
- "description": "an alternate display text of the service offering.",
- "name": "displaytext",
- "type": "string"
- },
- {
- "description": "is this a default system vm offering",
- "name": "defaultuse",
- "type": "boolean"
- },
- {
- "description": "the max iops of the disk offering",
- "name": "maxiops",
- "type": "long"
- },
- {
- "description": "length (in seconds) of the burst",
- "name": "diskIopsWriteRateMaxLength",
- "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": "length (in seconds) of the burst",
- "name": "diskBytesWriteRateMaxLength",
- "type": "long"
- },
- {
"description": "the tags for the service offering",
"name": "storagetags",
"type": "string"
},
{
- "description": "data transfer rate in megabits per second allowed.",
- "name": "networkrate",
- "type": "integer"
+ "description": "the ha support in the service offering",
+ "name": "offerha",
+ "type": "boolean"
},
- {},
{
- "description": "is this a the systemvm type for system vm offering",
- "name": "systemvmtype",
+ "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
+ "name": "zone",
"type": "string"
},
{
- "description": "is this a system vm offering",
- "name": "issystem",
- "type": "boolean"
- },
- {
- "description": "the clock rate CPU speed in Mhz",
- "name": "cpuspeed",
- "type": "integer"
- },
- {
- "description": "restrict the CPU usage to committed service offering",
- "name": "limitcpuuse",
- "type": "boolean"
- },
- {
"description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
"name": "domainid",
"type": "string"
},
{
- "description": "io requests write rate of the service offering",
- "name": "diskIopsWriteRate",
- "type": "long"
- },
- {
- "description": "burst io requests read rate of the disk offering",
- "name": "diskIopsReadRateMax",
- "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 host tag for the service offering",
- "name": "hosttags",
- "type": "string"
- },
- {
"description": "the cache mode to use for this disk offering. none, writeback or writethrough",
"name": "cacheMode",
"type": "string"
},
{
+ "description": "is true if the offering is customized",
+ "name": "iscustomized",
+ "type": "boolean"
+ },
+ {
+ "description": "bytes write rate of the service offering",
+ "name": "diskBytesWriteRate",
+ "type": "long"
+ },
+ {
+ "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)",
+ "name": "hypervisorsnapshotreserve",
+ "type": "integer"
+ },
+ {
+ "description": "an alternate display text of the service offering.",
+ "name": "displaytext",
+ "type": "string"
+ },
+ {
+ "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "io requests write rate of the service offering",
+ "name": "diskIopsWriteRate",
+ "type": "long"
+ },
+ {
+ "description": "io requests read rate of the service offering",
+ "name": "diskIopsReadRate",
+ "type": "long"
+ },
+ {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
{
- "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
- "name": "zone",
+ "description": "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": "length (in second) of the burst",
- "name": "diskIopsReadRateMaxLength",
+ "description": "length (in seconds) of the burst",
+ "name": "diskBytesWriteRateMaxLength",
"type": "long"
},
{
@@ -114383,9 +116086,20 @@
"type": "long"
},
{
- "description": "true if disk offering uses custom iops, false otherwise",
- "name": "iscustomizediops",
- "type": "boolean"
+ "description": "the id of the service offering",
+ "name": "id",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the storage type for this service offering",
+ "name": "storagetype",
+ "type": "string"
+ },
+ {
+ "description": "length (in seconds) of the burst",
+ "name": "diskBytesReadRateMaxLength",
+ "type": "long"
},
{
"description": "burst io requests write rate of the disk offering",
@@ -114393,73 +116107,8 @@
"type": "long"
},
{
- "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",
- "type": "string"
- },
- {
- "description": "additional key/value details tied with this service offering",
- "name": "serviceofferingdetails",
- "type": "map"
- },
- {
- "description": "the vsphere storage policy tagged to the service offering in case of VMware",
- "name": "vspherestoragepolicy",
- "type": "string"
- },
- {
- "description": "the date this service offering was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "io requests read rate of the service offering",
- "name": "diskIopsReadRate",
- "type": "long"
- },
- {
- "description": "is true if the offering is customized",
- "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": "the number of CPU",
- "name": "cpunumber",
- "type": "integer"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "bytes read rate of the service offering",
- "name": "diskBytesReadRate",
- "type": "long"
- },
- {
- "description": "deployment strategy used to deploy VM.",
- "name": "deploymentplanner",
- "type": "string"
- },
- {
- "description": "the memory in MB",
- "name": "memory",
- "type": "integer"
- },
- {
"description": "length (in seconds) of the burst",
- "name": "diskBytesReadRateMaxLength",
+ "name": "diskIopsWriteRateMaxLength",
"type": "long"
},
{
@@ -114468,9 +116117,130 @@
"type": "boolean"
},
{
- "description": "the storage type for this service offering",
- "name": "storagetype",
+ "description": "is this a system vm offering",
+ "name": "issystem",
+ "type": "boolean"
+ },
+ {
+ "description": "true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk",
+ "name": "isvolatile",
+ "type": "boolean"
+ },
+ {
+ "description": "true if disk offering uses custom iops, false otherwise",
+ "name": "iscustomizediops",
+ "type": "boolean"
+ },
+ {
+ "description": "burst bytes write rate of the disk offering",
+ "name": "diskBytesWriteRateMax",
+ "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": "is this a default system vm offering",
+ "name": "defaultuse",
+ "type": "boolean"
+ },
+ {
+ "description": "the name of the service offering",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "deployment strategy used to deploy VM.",
+ "name": "deploymentplanner",
+ "type": "string"
+ },
+ {
+ "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": "the date this service offering was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the number of CPU",
+ "name": "cpunumber",
+ "type": "integer"
+ },
+ {
+ "description": "burst io requests read rate of the disk offering",
+ "name": "diskIopsReadRateMax",
+ "type": "long"
+ },
+ {
+ "description": "burst bytes read rate of the disk offering",
+ "name": "diskBytesReadRateMax",
+ "type": "long"
+ },
+ {
+ "description": "restrict the CPU usage to committed service offering",
+ "name": "limitcpuuse",
+ "type": "boolean"
+ },
+ {
+ "description": "the vsphere storage policy tagged to the service offering in case of VMware",
+ "name": "vspherestoragepolicy",
+ "type": "string"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "length (in second) of the burst",
+ "name": "diskIopsReadRateMaxLength",
+ "type": "long"
+ },
+ {
+ "description": "is this a the systemvm type for system vm offering",
+ "name": "systemvmtype",
+ "type": "string"
+ },
+ {
+ "description": "the max iops of the disk offering",
+ "name": "maxiops",
+ "type": "long"
+ },
+ {
+ "description": "Root disk size in GB",
+ "name": "rootdisksize",
+ "type": "long"
+ },
+ {
+ "description": "the memory in MB",
+ "name": "memory",
+ "type": "integer"
+ },
+ {
+ "description": "the host tag for the service offering",
+ "name": "hosttags",
+ "type": "string"
+ },
+ {
+ "description": "the clock rate CPU speed in Mhz",
+ "name": "cpuspeed",
+ "type": "integer"
+ },
+ {
+ "description": "additional key/value details tied with this service offering",
+ "name": "serviceofferingdetails",
+ "type": "map"
}
]
},
@@ -114480,43 +116250,43 @@
"name": "removeFromGlobalLoadBalancerRule",
"params": [
{
- "description": "the list load balancer rules that will be assigned to gloabal load balancer rule",
- "length": 255,
- "name": "loadbalancerrulelist",
- "related": "",
- "required": true,
- "type": "list"
- },
- {
"description": "The ID of the load balancer rule",
"length": 255,
"name": "id",
"related": "",
"required": true,
"type": "uuid"
+ },
+ {
+ "description": "the list load balancer rules that will be assigned to gloabal load balancer rule",
+ "length": 255,
+ "name": "loadbalancerrulelist",
+ "related": "",
+ "required": true,
+ "type": "list"
}
],
"response": [
{},
{
+ "description": "any text associated with the success or failure",
+ "name": "displaytext",
+ "type": "string"
+ },
+ {},
+ {
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
{
- "description": "the UUID 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"
}
]
@@ -114534,26 +116304,26 @@
"type": "integer"
},
{
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
- },
- {
"description": "",
"length": 255,
"name": "page",
"required": false,
"type": "integer"
+ },
+ {
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
}
],
"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"
},
{},
{
@@ -114561,12 +116331,12 @@
"name": "type",
"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"
+ },
+ {}
]
},
{
@@ -114575,6 +116345,22 @@
"name": "listCapacity",
"params": [
{
+ "description": "lists capacity by the Pod ID",
+ "length": 255,
+ "name": "podid",
+ "related": "",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "Sort the results. Available values: Usage",
+ "length": 255,
+ "name": "sortby",
+ "required": false,
+ "since": "3.0.0",
+ "type": "string"
+ },
+ {
"description": "lists capacity by the Zone ID",
"length": 255,
"name": "zoneid",
@@ -114592,29 +116378,6 @@
"type": "uuid"
},
{
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
- },
- {
- "description": "lists capacity by the Pod ID",
- "length": 255,
- "name": "podid",
- "related": "",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "recalculate capacities and fetch the latest",
- "length": 255,
- "name": "fetchlatest",
- "required": false,
- "since": "3.0.0",
- "type": "boolean"
- },
- {
"description": "",
"length": 255,
"name": "pagesize",
@@ -114636,49 +116399,72 @@
"type": "integer"
},
{
- "description": "Sort the results. Available values: Usage",
+ "description": "recalculate capacities and fetch the latest",
"length": 255,
- "name": "sortby",
+ "name": "fetchlatest",
"required": false,
"since": "3.0.0",
+ "type": "boolean"
+ },
+ {
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
"type": "string"
}
],
"related": "",
"response": [
{
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the capacity currently in allocated",
+ "name": "capacityallocated",
+ "type": "long"
+ },
+ {
+ "description": "the percentage of capacity currently in use",
+ "name": "percentused",
+ "type": "string"
+ },
+ {
+ "description": "the capacity currently in use",
+ "name": "capacityused",
+ "type": "long"
+ },
+ {
"description": "the 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 capacity name",
"name": "name",
"type": "string"
},
{
+ "description": "the total capacity available",
+ "name": "capacitytotal",
+ "type": "long"
+ },
+ {
"description": "the Pod name",
"name": "podname",
"type": "string"
},
{
- "description": "the Pod ID",
- "name": "podid",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the Cluster ID",
- "name": "clusterid",
- "type": "string"
- },
- {
- "description": "the percentage of capacity currently in use",
- "name": "percentused",
+ "description": "the Cluster name",
+ "name": "clustername",
"type": "string"
},
{
@@ -114687,36 +116473,20 @@
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the total capacity available",
- "name": "capacitytotal",
- "type": "long"
- },
- {
- "description": "the Cluster name",
- "name": "clustername",
+ "description": "the Pod ID",
+ "name": "podid",
"type": "string"
},
{},
- {},
- {
- "description": "the capacity currently in allocated",
- "name": "capacityallocated",
- "type": "long"
- },
- {
- "description": "the capacity currently in use",
- "name": "capacityused",
- "type": "long"
- },
{
"description": "the Zone name",
"name": "zonename",
"type": "string"
+ },
+ {
+ "description": "the Cluster ID",
+ "name": "clusterid",
+ "type": "string"
}
]
},
@@ -114726,12 +116496,12 @@
"name": "startVirtualMachine",
"params": [
{
- "description": "Deployment planner to use for vm allocation. Available to ROOT admin only",
+ "description": "Boot into hardware setup menu or not",
"length": 255,
- "name": "deploymentplanner",
+ "name": "bootintosetup",
"required": false,
- "since": "4.4",
- "type": "string"
+ "since": "4.15.0.0",
+ "type": "boolean"
},
{
"description": "The ID of the virtual machine",
@@ -114742,9 +116512,9 @@
"type": "uuid"
},
{
- "description": "destination Cluster ID to deploy the VM to - parameter available for root admin only",
+ "description": "destination Pod ID to deploy the VM to - parameter available for root admin only",
"length": 255,
- "name": "clusterid",
+ "name": "podid",
"related": "",
"required": false,
"type": "uuid"
@@ -114759,639 +116529,48 @@
"type": "uuid"
},
{
- "description": "destination Pod ID to deploy the VM to - parameter available for root admin only",
+ "description": "Deployment planner to use for vm allocation. Available to ROOT admin only",
"length": 255,
- "name": "podid",
+ "name": "deploymentplanner",
+ "required": false,
+ "since": "4.4",
+ "type": "string"
+ },
+ {
+ "description": "destination Cluster ID to deploy the VM to - parameter available for root admin only",
+ "length": 255,
+ "name": "clusterid",
"related": "",
"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"
}
],
"related": "scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines",
"response": [
- {
- "description": "Guest vm Boot Type",
- "name": "boottype",
- "type": "string"
- },
- {
- "description": "the pool type of the virtual machine",
- "name": "pooltype",
- "type": "string"
- },
- {
- "description": "the name of the template for the virtual machine",
- "name": "templatename",
- "type": "string"
- },
- {
- "description": "the date when this virtual machine was updated last time",
- "name": "lastupdated",
- "type": "date"
- },
- {
- "description": "the password (if exists) of the virtual machine",
- "name": "password",
- "type": "string"
- },
- {
- "description": "the ID of the host for the virtual machine",
- "name": "hostid",
- "type": "string"
- },
- {
- "description": "Os type ID of the virtual machine",
- "name": "guestosid",
- "type": "string"
- },
{},
{
- "description": "the name of the ISO attached to the virtual machine",
- "name": "isoname",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the hypervisor on which the template runs",
- "name": "hypervisor",
- "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": "device id for the network when plugged into the virtual machine",
- "name": "deviceid",
- "type": "string"
- },
- {
- "description": "the ID of the nic",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the isolated private VLAN type if available",
- "name": "isolatedpvlantype",
- "type": "string"
- },
- {
- "description": "the gateway of the nic",
- "name": "gateway",
- "type": "string"
- },
- {
- "description": "Id of the vm to which the nic belongs",
- "name": "virtualmachineid",
- "type": "string"
- },
- {
- "description": "true if nic is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
- },
- {
- "description": "the gateway of IPv6 network",
- "name": "ip6gateway",
- "type": "string"
- },
- {
- "description": "Type of adapter if available",
- "name": "adaptertype",
- "type": "string"
- },
- {
- "description": "the cidr of IPv6 network",
- "name": "ip6cidr",
- "type": "string"
- },
- {
- "description": "the IPv6 address of network",
- "name": "ip6address",
- "type": "string"
- },
- {
- "description": "the ip address of the nic",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "description": "the isolated private VLAN if available",
- "name": "isolatedpvlan",
- "type": "integer"
- },
- {
- "description": "true if nic is default, false otherwise",
- "name": "macaddress",
- "type": "string"
- },
- {
- "description": "Id of the NSX Logical Switch (if NSX based), null otherwise",
- "name": "nsxlogicalswitch",
- "type": "string"
- },
- {
- "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise",
- "name": "nsxlogicalswitchport",
- "type": "string"
- },
- {
- "description": "the netmask of the nic",
- "name": "netmask",
- "type": "string"
- },
- {
- "description": "the type of the nic",
- "name": "type",
- "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 VLAN/VNI if available",
- "name": "vlanid",
- "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 ID of the corresponding network",
- "name": "networkid",
- "type": "string"
- },
- {
- "description": "the extra dhcp options on the nic",
- "name": "extradhcpoption",
- "type": "list"
- },
- {
- "description": "the traffic type of the nic",
- "name": "traffictype",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "list of security groups associated with the virtual machine",
- "name": "securitygroup",
- "response": [
- {
- "description": "the list of resource tags associated with the rule",
- "name": "tags",
- "response": [
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the domain name of the security group",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the list of ingress rules associated with the security group",
- "name": "ingressrule",
- "response": [
- {
- "description": "the starting IP of the security group rule",
- "name": "startport",
- "type": "integer"
- },
- {
- "description": "security group name",
- "name": "securitygroupname",
- "type": "string"
- },
- {
- "description": "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": "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": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the id of the security group rule",
- "name": "ruleid",
- "type": "string"
- },
- {
- "description": "the protocol of the security group rule",
- "name": "protocol",
- "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 CIDR notation for the base IP address of the security group rule",
- "name": "cidr",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the ID of the security group",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the name of the security group",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the account owning the security group",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the project id of the group",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the list of virtualmachine ids associated with this securitygroup",
- "name": "virtualmachineids",
- "type": "set"
- },
- {
- "description": "the list of egress rules associated with the security group",
- "name": "egressrule",
- "response": [
- {
- "description": "security group name",
- "name": "securitygroupname",
- "type": "string"
- },
- {
- "description": "account owning the security group rule",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the list of resource tags associated with the rule",
- "name": "tags",
- "response": [
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "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"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the CIDR notation for the base IP address of the security group rule",
- "name": "cidr",
- "type": "string"
- },
- {
- "description": "the 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 starting IP of the security group rule",
- "name": "startport",
- "type": "integer"
- },
- {
- "description": "the id of the security group rule",
- "name": "ruleid",
- "type": "string"
- },
- {
- "description": "the code for the ICMP message response",
- "name": "icmpcode",
- "type": "integer"
- }
- ],
- "type": "set"
- },
- {
- "description": "the 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 number of virtualmachines associated with this securitygroup",
- "name": "virtualmachinecount",
- "type": "integer"
- }
- ],
- "type": "set"
- },
- {
"description": "the internal memory that's free in vm or zero if it can not be calculated",
"name": "memoryintfreekbs",
"type": "long"
},
{
- "description": "the vgpu type used by the virtual machine",
- "name": "vgpu",
+ "description": "the group name of the virtual machine",
+ "name": "group",
"type": "string"
},
{
- "description": "the memory used by the vm",
- "name": "memorykbs",
+ "description": "the speed of each cpu",
+ "name": "cpuspeed",
+ "type": "integer"
+ },
+ {
+ "description": "the read (io) of disk on the vm",
+ "name": "diskioread",
"type": "long"
},
{
- "description": "the project id of the vm",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the list of resource tags associated",
- "name": "tags",
- "response": [
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the 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": "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": "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 ID of the availablility zone for the virtual machine",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the name of the backup offering of the virtual machine",
- "name": "backupofferingname",
- "type": "string"
- },
- {
- "description": "Vm details in key/value pairs.",
- "name": "details",
- "type": "map"
- },
- {
- "description": " an alternate display text of the template for the virtual machine",
- "name": "templatedisplaytext",
+ "description": "the account associated with the virtual machine",
+ "name": "account",
"type": "string"
},
{
@@ -115400,103 +116579,8 @@
"type": "string"
},
{
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
- },
- {
- "description": "the ID of the virtual machine",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the ID of the ISO attached to the virtual machine",
- "name": "isoid",
- "type": "string"
- },
- {
- "description": "true if the password rest feature is enabled, false otherwise",
- "name": "passwordenabled",
- "type": "boolean"
- },
- {
- "description": "the 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 group name of the virtual machine",
- "name": "group",
- "type": "string"
- },
- {
- "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": "the read (bytes) of disk on the vm",
- "name": "diskkbsread",
- "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 group ID of the virtual machine",
- "name": "groupid",
- "type": "string"
- },
- {
- "description": "State of the Service from LB rule",
- "name": "servicestate",
- "type": "string"
- },
- {
- "description": "the name of the service offering of the virtual machine",
- "name": "serviceofferingname",
- "type": "string"
- },
- {
- "description": "true if high-availability is enabled, false otherwise",
- "name": "haenable",
- "type": "boolean"
- },
- {
- "description": "the name of the virtual machine",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the name of the host for the virtual machine",
- "name": "hostname",
- "type": "string"
- },
- {
- "description": "the name of the disk offering of the virtual machine",
- "name": "diskofferingname",
- "type": "string"
- },
- {
- "description": "the project name of the vm",
- "name": "project",
+ "description": "the ID of the host for the virtual machine",
+ "name": "hostid",
"type": "string"
},
{
@@ -115505,114 +116589,37 @@
"type": "long"
},
{
- "description": "the state of the virtual machine",
- "name": "state",
- "type": "string"
- },
- {
- "description": "the ID of the disk offering of the virtual machine",
- "name": "diskofferingid",
- "type": "string"
- },
- {
- "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.",
- "name": "isdynamicallyscalable",
- "type": "boolean"
- },
- {
- "description": "the ID of the backup offering of the virtual machine",
- "name": "backupofferingid",
- "type": "string"
- },
- {
- "description": "the name of the domain in which the virtual machine exists",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the ID of the domain in which the virtual machine exists",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "user generated name. The name of the virtual machine is returned if no displayname exists.",
- "name": "displayname",
- "type": "string"
- },
- {
- "description": "the account associated with the virtual machine",
- "name": "account",
- "type": "string"
- },
- {
- "description": "Guest vm Boot Mode",
- "name": "bootmode",
- "type": "string"
- },
- {
- "description": "the number of cpu this virtual machine is running with",
- "name": "cpunumber",
- "type": "integer"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {},
- {
- "description": "an optional field whether to the display the vm to the end user or not.",
- "name": "displayvm",
- "type": "boolean"
- },
- {
- "description": "instance name of the user vm; this parameter is returned to the ROOT admin only",
- "name": "instancename",
- "type": "string"
- },
- {
- "description": "the total number of network traffic bytes sent",
- "name": "sentbytes",
+ "description": "the target memory in vm",
+ "name": "memorytargetkbs",
"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 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": "the write (bytes) of disk on the vm",
- "name": "diskkbswrite",
+ "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 name of the service offering of the virtual machine",
+ "name": "serviceofferingname",
+ "type": "string"
+ },
+ {
+ "description": " an alternate display text of the template for the virtual machine",
+ "name": "templatedisplaytext",
+ "type": "string"
},
{
"description": "list of affinity groups associated with the virtual machine",
"name": "affinitygroup",
"response": [
{
- "description": "the ID of the affinity group",
- "name": "id",
+ "description": "the type of the affinity group",
+ "name": "type",
+ "type": "string"
+ },
+ {
+ "description": "the account owning the affinity group",
+ "name": "account",
"type": "string"
},
{
@@ -115621,11 +116628,26 @@
"type": "string"
},
{
+ "description": "the ID of the affinity group",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the project ID of the affinity group",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
"description": "the 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"
@@ -115636,26 +116658,6 @@
"type": "string"
},
{
- "description": "the type of the affinity group",
- "name": "type",
- "type": "string"
- },
- {
- "description": "the description of the affinity group",
- "name": "description",
- "type": "string"
- },
- {
- "description": "the account owning the affinity group",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the project ID of the affinity group",
- "name": "projectid",
- "type": "string"
- },
- {
"description": "virtual machine IDs associated with this affinity group",
"name": "virtualmachineIds",
"type": "list"
@@ -115664,23 +116666,155 @@
"type": "set"
},
{
- "description": "public IP address id associated with vm via Static nat rule",
- "name": "publicip",
+ "description": "the ID of the availablility zone for the virtual machine",
+ "name": "zoneid",
"type": "string"
},
{
- "description": "the read (io) of disk on the vm",
- "name": "diskioread",
- "type": "long"
+ "description": "the project name of the vm",
+ "name": "project",
+ "type": "string"
},
{
- "description": "the speed of each cpu",
- "name": "cpuspeed",
- "type": "integer"
+ "description": "the list of nics associated with vm",
+ "name": "nic",
+ "response": [
+ {
+ "description": "the cidr of IPv6 network",
+ "name": "ip6cidr",
+ "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 Secondary ipv4 addr of nic",
+ "name": "secondaryip",
+ "type": "list"
+ },
+ {
+ "description": "the ID of the nic",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the gateway of the nic",
+ "name": "gateway",
+ "type": "string"
+ },
+ {
+ "description": "the isolated private VLAN type if available",
+ "name": "isolatedpvlantype",
+ "type": "string"
+ },
+ {
+ "description": "the netmask of the nic",
+ "name": "netmask",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the corresponding network",
+ "name": "networkid",
+ "type": "string"
+ },
+ {
+ "description": "the traffic type of the nic",
+ "name": "traffictype",
+ "type": "string"
+ },
+ {
+ "description": "true if nic is default, false otherwise",
+ "name": "macaddress",
+ "type": "string"
+ },
+ {
+ "description": "true if nic is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {
+ "description": "the IPv6 address of network",
+ "name": "ip6address",
+ "type": "string"
+ },
+ {
+ "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise",
+ "name": "nsxlogicalswitchport",
+ "type": "string"
+ },
+ {
+ "description": "Id of the NSX Logical Switch (if NSX based), null otherwise",
+ "name": "nsxlogicalswitch",
+ "type": "string"
+ },
+ {
+ "description": "the ip address of the nic",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "the isolated private VLAN if available",
+ "name": "isolatedpvlan",
+ "type": "integer"
+ },
+ {
+ "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": "ID of the VLAN/VNI if available",
+ "name": "vlanid",
+ "type": "integer"
+ },
+ {
+ "description": "the broadcast uri of the nic",
+ "name": "broadcasturi",
+ "type": "string"
+ },
+ {
+ "description": "IP addresses associated with NIC found for unmanaged VM",
+ "name": "ipaddresses",
+ "type": "list"
+ },
+ {
+ "description": "the name of the corresponding network",
+ "name": "networkname",
+ "type": "string"
+ },
+ {
+ "description": "the gateway of IPv6 network",
+ "name": "ip6gateway",
+ "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"
+ }
+ ],
+ "type": "set"
},
{
- "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.",
- "name": "templateid",
+ "description": "the name of the virtual machine",
+ "name": "name",
"type": "string"
},
{
@@ -115689,28 +116823,506 @@
"type": "boolean"
},
{
- "description": "OS name of the vm",
- "name": "osdisplayname",
+ "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": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
- "description": "the target memory in vm",
- "name": "memorytargetkbs",
+ "description": "the name of the template for the virtual machine",
+ "name": "templatename",
+ "type": "string"
+ },
+ {
+ "description": "the name of the disk offering of the virtual machine",
+ "name": "diskofferingname",
+ "type": "string"
+ },
+ {
+ "description": "the user's ID who deployed the virtual machine",
+ "name": "userid",
+ "type": "string"
+ },
+ {
+ "description": "public IP address id associated with vm via Static nat rule",
+ "name": "publicip",
+ "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": "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 hypervisor on which the template runs",
+ "name": "hypervisor",
+ "type": "string"
+ },
+ {
+ "description": "device ID of the root volume",
+ "name": "rootdeviceid",
"type": "long"
},
{
+ "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.",
+ "name": "isdynamicallyscalable",
+ "type": "boolean"
+ },
+ {},
+ {
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "description": "the ID of the disk offering of the virtual machine",
+ "name": "diskofferingid",
+ "type": "string"
+ },
+ {
+ "description": "the number of cpu this virtual machine is running with",
+ "name": "cpunumber",
+ "type": "integer"
+ },
+ {
+ "description": "list of security groups associated with the virtual machine",
+ "name": "securitygroup",
+ "response": [
+ {
+ "description": "the list of ingress rules associated with the security group",
+ "name": "ingressrule",
+ "response": [
+ {
+ "description": "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 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 id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "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"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the code for the ICMP message response",
+ "name": "icmpcode",
+ "type": "integer"
+ },
+ {
+ "description": "security group name",
+ "name": "securitygroupname",
+ "type": "string"
+ },
+ {
+ "description": "the protocol of the security group rule",
+ "name": "protocol",
+ "type": "string"
+ },
+ {
+ "description": "the CIDR notation for the base IP address of the security group rule",
+ "name": "cidr",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the list of virtualmachine ids associated with this securitygroup",
+ "name": "virtualmachineids",
+ "type": "set"
+ },
+ {
+ "description": "the account owning the security group",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the project id of the group",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the number of virtualmachines associated with this securitygroup",
+ "name": "virtualmachinecount",
+ "type": "integer"
+ },
+ {
+ "description": "the project name of the group",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the security group",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the name of the security group",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID of the security group",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the list of resource tags associated with the rule",
+ "name": "tags",
+ "response": [
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "the 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": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ }
+ ],
+ "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 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": "account owning the security group rule",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the list of resource tags associated with the rule",
+ "name": "tags",
+ "response": [
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "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": "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 domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "security group name",
+ "name": "securitygroupname",
+ "type": "string"
+ },
+ {
+ "description": "the type of the ICMP message response",
+ "name": "icmptype",
+ "type": "integer"
+ },
+ {
+ "description": "the code for the ICMP message response",
+ "name": "icmpcode",
+ "type": "integer"
+ },
+ {
+ "description": "the protocol of the security group rule",
+ "name": "protocol",
+ "type": "string"
+ },
+ {
+ "description": "the CIDR notation for the base IP address of the security group rule",
+ "name": "cidr",
+ "type": "string"
+ },
+ {
+ "description": "the starting IP of the security group rule",
+ "name": "startport",
+ "type": "integer"
+ }
+ ],
+ "type": "set"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "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 date when this virtual machine was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "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 host for the virtual machine",
+ "name": "hostname",
+ "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": "OS type id of the vm",
"name": "ostypeid",
"type": "string"
},
{
- "description": "the outgoing network traffic on the host",
- "name": "networkkbswrite",
+ "description": "State of the Service from LB rule",
+ "name": "servicestate",
+ "type": "string"
+ },
+ {
+ "description": "Os type ID of the virtual machine",
+ "name": "guestosid",
+ "type": "string"
+ },
+ {
+ "description": "public IP address id associated with vm via Static nat rule",
+ "name": "publicipid",
+ "type": "string"
+ },
+ {
+ "description": "the virtual network for the service offering",
+ "name": "forvirtualnetwork",
+ "type": "boolean"
+ },
+ {
+ "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",
+ "type": "string"
+ },
+ {
+ "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": "the write (bytes) of disk on the vm",
+ "name": "diskkbswrite",
"type": "long"
},
{
@@ -115719,14 +117331,172 @@
"type": "integer"
},
{
- "description": "public IP address id associated with vm via Static nat rule",
- "name": "publicipid",
+ "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": "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": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the state of the virtual machine",
+ "name": "state",
"type": "string"
},
{
- "description": "the total number of network traffic bytes received",
- "name": "receivedbytes",
+ "description": "the name of the availability zone for the virtual machine",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "an alternate display text of the ISO attached to the virtual machine",
+ "name": "isodisplaytext",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the vm's CPU currently used",
+ "name": "cpuused",
+ "type": "string"
+ },
+ {
+ "description": "the memory used by the vm",
+ "name": "memorykbs",
"type": "long"
+ },
+ {
+ "description": "the ID of the domain in which the virtual machine exists",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "OS name of the vm",
+ "name": "osdisplayname",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the ISO attached to the virtual machine",
+ "name": "isoid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the backup offering of the virtual machine",
+ "name": "backupofferingid",
+ "type": "string"
+ },
+ {
+ "description": "the pool type of the virtual machine",
+ "name": "pooltype",
+ "type": "string"
+ },
+ {
+ "description": "the user's name who deployed the virtual machine",
+ "name": "username",
+ "type": "string"
+ },
+ {
+ "description": "the name of the backup offering of the virtual machine",
+ "name": "backupofferingname",
+ "type": "string"
+ },
+ {
+ "description": "Guest vm Boot Mode",
+ "name": "bootmode",
+ "type": "string"
+ },
+ {
+ "description": "Vm details in key/value pairs.",
+ "name": "details",
+ "type": "map"
+ },
+ {
+ "description": "the read (bytes) of disk on the vm",
+ "name": "diskkbsread",
+ "type": "long"
+ },
+ {
+ "description": "List of read-only Vm details as comma separated string.",
+ "name": "readonlydetails",
+ "type": "string"
+ },
+ {
+ "description": "the name of the domain in which the virtual machine exists",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the outgoing network traffic on the host",
+ "name": "networkkbswrite",
+ "type": "long"
+ },
+ {},
+ {
+ "description": "the vgpu type used by the virtual machine",
+ "name": "vgpu",
+ "type": "string"
+ },
+ {
+ "description": "the date when this virtual machine was updated last time",
+ "name": "lastupdated",
+ "type": "date"
+ },
+ {
+ "description": "true if the password rest feature is enabled, false otherwise",
+ "name": "passwordenabled",
+ "type": "boolean"
}
]
},
@@ -115736,6 +117506,28 @@
"name": "updateServiceOffering",
"params": [
{
+ "description": "the ID of the service offering to be updated",
+ "length": 255,
+ "name": "id",
+ "related": "updateServiceOffering",
+ "required": true,
+ "type": "uuid"
+ },
+ {
+ "description": "the ID of the containing domain(s) as comma separated string, public for public offerings",
+ "length": 255,
+ "name": "domainid",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the name of the service offering to be updated",
+ "length": 255,
+ "name": "name",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings",
"length": 255,
"name": "zoneid",
@@ -115744,9 +117536,9 @@
"type": "string"
},
{
- "description": "the host tag for this service offering.",
+ "description": "comma-separated list of tags for the service offering, tags should match with existing storage pool tags",
"length": 255,
- "name": "hosttags",
+ "name": "storagetags",
"required": false,
"since": "4.16",
"type": "string"
@@ -115759,251 +117551,77 @@
"type": "string"
},
{
- "description": "the name of the service offering to be updated",
- "length": 255,
- "name": "name",
- "required": false,
- "type": "string"
- },
- {
- "description": "the ID of the containing domain(s) as comma separated string, public for public offerings",
- "length": 255,
- "name": "domainid",
- "required": false,
- "type": "string"
- },
- {
- "description": "the ID of the service offering to be updated",
- "length": 255,
- "name": "id",
- "related": "updateServiceOffering",
- "required": true,
- "type": "uuid"
- },
- {
- "description": "comma-separated list of tags for the service offering, tags should match with existing storage pool tags",
- "length": 255,
- "name": "storagetags",
- "required": false,
- "since": "4.16",
- "type": "string"
- },
- {
"description": "sort key of the service offering, integer",
"length": 255,
"name": "sortkey",
"required": false,
"type": "integer"
+ },
+ {
+ "description": "the host tag for this service offering.",
+ "length": 255,
+ "name": "hosttags",
+ "required": false,
+ "since": "4.16",
+ "type": "string"
}
],
"related": "",
"response": [
{
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "is this a system vm offering",
- "name": "issystem",
- "type": "boolean"
- },
- {
- "description": "the cache mode to use for this disk offering. none, writeback or writethrough",
- "name": "cacheMode",
- "type": "string"
- },
- {
- "description": "bytes read rate of the service offering",
- "name": "diskBytesReadRate",
- "type": "long"
- },
- {
- "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)",
- "name": "hypervisorsnapshotreserve",
- "type": "integer"
- },
- {
- "description": "burst bytes read rate of the disk offering",
- "name": "diskBytesReadRateMax",
- "type": "long"
- },
- {},
- {
- "description": "length (in seconds) of the burst",
- "name": "diskBytesReadRateMaxLength",
- "type": "long"
- },
- {
- "description": "the storage type for this service offering",
- "name": "storagetype",
- "type": "string"
- },
- {
- "description": "the clock rate CPU speed in Mhz",
- "name": "cpuspeed",
- "type": "integer"
- },
- {
- "description": "is true if the offering is customized",
- "name": "iscustomized",
- "type": "boolean"
- },
- {
"description": "the id of the service offering",
"name": "id",
"type": "string"
},
{
+ "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.",
+ "name": "provisioningtype",
+ "type": "string"
+ },
+ {
+ "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",
"type": "boolean"
},
{
- "description": "the number of CPU",
- "name": "cpunumber",
+ "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)",
+ "name": "hypervisorsnapshotreserve",
"type": "integer"
},
- {},
- {
- "description": "Root disk size in GB",
- "name": "rootdisksize",
- "type": "long"
- },
{
"description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
"name": "zone",
"type": "string"
},
{
- "description": "the tags for the service offering",
- "name": "storagetags",
- "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 virtual machine needs to be dynamically scalable of cpu or memory",
- "name": "dynamicscalingenabled",
- "type": "boolean"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "additional key/value details tied with this service offering",
- "name": "serviceofferingdetails",
- "type": "map"
- },
- {
- "description": "restrict the CPU usage to committed service offering",
- "name": "limitcpuuse",
- "type": "boolean"
- },
- {
- "description": "deployment strategy used to deploy VM.",
- "name": "deploymentplanner",
- "type": "string"
- },
- {
- "description": "length (in second) of the burst",
- "name": "diskIopsReadRateMaxLength",
- "type": "long"
- },
- {
- "description": "the ha support in the service offering",
- "name": "offerha",
- "type": "boolean"
- },
- {
- "description": "bytes write rate of the service offering",
- "name": "diskBytesWriteRate",
- "type": "long"
- },
- {
- "description": "length (in seconds) of the burst",
- "name": "diskBytesWriteRateMaxLength",
- "type": "long"
- },
- {
- "description": "the name of the service offering",
- "name": "name",
- "type": "string"
- },
- {
"description": "burst io requests read rate of the disk offering",
"name": "diskIopsReadRateMax",
"type": "long"
},
{
- "description": "the max iops of the disk offering",
- "name": "maxiops",
+ "description": "the min iops of the disk offering",
+ "name": "miniops",
"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": "is this a the systemvm type for system vm offering",
- "name": "systemvmtype",
+ "description": "an alternate display text of the service offering.",
+ "name": "displaytext",
"type": "string"
},
{
- "description": "length (in seconds) of the burst",
- "name": "diskIopsWriteRateMaxLength",
- "type": "long"
- },
- {
"description": "the memory in MB",
"name": "memory",
"type": "integer"
},
{
- "description": "burst io requests write rate of the disk offering",
- "name": "diskIopsWriteRateMax",
- "type": "long"
- },
- {
- "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.",
- "name": "provisioningtype",
- "type": "string"
- },
- {
- "description": "the min iops of the disk offering",
- "name": "miniops",
- "type": "long"
- },
- {
- "description": "the date this service offering was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "is this a default system vm offering",
- "name": "defaultuse",
- "type": "boolean"
- },
- {
- "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": "the number of CPU",
+ "name": "cpunumber",
+ "type": "integer"
},
{
"description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
@@ -116016,30 +117634,182 @@
"type": "long"
},
{
+ "description": "the host tag for the service offering",
+ "name": "hosttags",
+ "type": "string"
+ },
+ {
+ "description": "burst bytes write rate of the disk offering",
+ "name": "diskBytesWriteRateMax",
+ "type": "long"
+ },
+ {
+ "description": "length (in second) of the burst",
+ "name": "diskIopsReadRateMaxLength",
+ "type": "long"
+ },
+ {
+ "description": "the name of the service offering",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the clock rate CPU speed in Mhz",
+ "name": "cpuspeed",
+ "type": "integer"
+ },
+ {},
+ {
+ "description": "is true if the offering is customized",
+ "name": "iscustomized",
+ "type": "boolean"
+ },
+ {
+ "description": "the max iops of the disk offering",
+ "name": "maxiops",
+ "type": "long"
+ },
+ {
"description": "data transfer rate in megabits per second allowed.",
"name": "networkrate",
"type": "integer"
},
{
- "description": "io requests read rate of the service offering",
- "name": "diskIopsReadRate",
+ "description": "bytes write rate of the service offering",
+ "name": "diskBytesWriteRate",
"type": "long"
},
{
+ "description": "the ha support in the service offering",
+ "name": "offerha",
+ "type": "boolean"
+ },
+ {
+ "description": "length (in seconds) of the burst",
+ "name": "diskIopsWriteRateMaxLength",
+ "type": "long"
+ },
+ {
+ "description": "burst bytes read rate of the disk offering",
+ "name": "diskBytesReadRateMax",
+ "type": "long"
+ },
+ {
+ "description": "is this a system vm offering",
+ "name": "issystem",
+ "type": "boolean"
+ },
+ {
+ "description": "the cache mode to use for this disk offering. none, writeback or writethrough",
+ "name": "cacheMode",
+ "type": "string"
+ },
+ {
+ "description": "additional key/value details tied with this service offering",
+ "name": "serviceofferingdetails",
+ "type": "map"
+ },
+ {
+ "description": "the storage type for this service offering",
+ "name": "storagetype",
+ "type": "string"
+ },
+ {
+ "description": "restrict the CPU usage to committed service offering",
+ "name": "limitcpuuse",
+ "type": "boolean"
+ },
+ {
+ "description": "the tags for the service offering",
+ "name": "storagetags",
+ "type": "string"
+ },
+ {
+ "description": "is this a the systemvm type for system vm offering",
+ "name": "systemvmtype",
+ "type": "string"
+ },
+ {
+ "description": "length (in seconds) of the burst",
+ "name": "diskBytesReadRateMaxLength",
+ "type": "long"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "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": "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 vsphere storage policy tagged to the service offering in case of VMware",
"name": "vspherestoragepolicy",
"type": "string"
},
{
+ "description": "the date this service offering was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "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 current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
{
- "description": "burst bytes write rate of the disk offering",
- "name": "diskBytesWriteRateMax",
+ "description": "io requests read rate of the service offering",
+ "name": "diskIopsReadRate",
"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": "bytes read rate of the service offering",
+ "name": "diskBytesReadRate",
+ "type": "long"
+ },
+ {
+ "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "deployment strategy used to deploy VM.",
+ "name": "deploymentplanner",
+ "type": "string"
+ },
+ {}
]
},
{
@@ -116048,35 +117818,672 @@
"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). The caller knows the VM is stopped.",
+ "length": 255,
+ "name": "forced",
+ "required": false,
+ "type": "boolean"
+ },
+ {
"description": "The ID of the virtual machine",
"length": 255,
"name": "id",
"related": "scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines",
"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). The caller knows the VM is stopped.",
- "length": 255,
- "name": "forced",
- "required": false,
- "type": "boolean"
}
],
"related": "scaleVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines",
"response": [
{
+ "description": "the vgpu type used by the virtual machine",
+ "name": "vgpu",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the name of the domain in which the virtual machine exists",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the name of the ISO attached to the virtual machine",
+ "name": "isoname",
+ "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",
+ "type": "string"
+ },
+ {
+ "description": "the speed of each cpu",
+ "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 memory used by the vm",
+ "name": "memorykbs",
+ "type": "long"
+ },
+ {
+ "description": "ssh key-pair",
+ "name": "keypair",
+ "type": "string"
+ },
+ {
+ "description": "List of read-only Vm details as comma separated string.",
+ "name": "readonlydetails",
+ "type": "string"
+ },
+ {
+ "description": "the name of the host for the virtual machine",
+ "name": "hostname",
+ "type": "string"
+ },
+ {
+ "description": "the internal memory that's free in vm or zero if it can not be calculated",
+ "name": "memoryintfreekbs",
+ "type": "long"
+ },
+ {
+ "description": "list of affinity groups associated with the virtual machine",
+ "name": "affinitygroup",
+ "response": [
+ {
+ "description": "the name of the affinity group",
+ "name": "name",
+ "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 ID of the affinity group",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "virtual machine IDs associated with this affinity group",
+ "name": "virtualmachineIds",
+ "type": "list"
+ },
+ {
+ "description": "the domain name of the affinity group",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the project ID of the affinity group",
+ "name": "projectid",
+ "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 account owning the affinity group",
+ "name": "account",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the read (io) of disk on the vm",
+ "name": "diskioread",
+ "type": "long"
+ },
+ {
+ "description": "the name of the disk offering of the virtual machine",
+ "name": "diskofferingname",
+ "type": "string"
+ },
+ {
+ "description": "Guest vm Boot Mode",
+ "name": "bootmode",
+ "type": "string"
+ },
+ {
+ "description": "device ID of the root volume",
+ "name": "rootdeviceid",
+ "type": "long"
+ },
+ {
+ "description": "the hypervisor on which the template runs",
+ "name": "hypervisor",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the host for the virtual machine",
+ "name": "hostid",
+ "type": "string"
+ },
+ {
+ "description": "the read (bytes) of disk on the vm",
+ "name": "diskkbsread",
+ "type": "long"
+ },
+ {
+ "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.",
+ "name": "templateid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the disk offering of the virtual machine",
+ "name": "diskofferingid",
+ "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 created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "Vm details in key/value pairs.",
+ "name": "details",
+ "type": "map"
+ },
+ {
+ "description": "an optional field whether to the display the vm to the end user or not.",
+ "name": "displayvm",
+ "type": "boolean"
+ },
+ {
+ "description": "true if high-availability is enabled, false otherwise",
+ "name": "haenable",
+ "type": "boolean"
+ },
+ {
+ "description": "the user's name who deployed the virtual machine",
+ "name": "username",
+ "type": "string"
+ },
+ {
+ "description": "the 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": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "description": "the date when this virtual machine was updated last time",
+ "name": "lastupdated",
+ "type": "date"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "public IP address id associated with vm via Static nat rule",
+ "name": "publicip",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the memory allocated for the virtual machine",
+ "name": "memory",
+ "type": "integer"
+ },
+ {
+ "description": "the name of the service offering of the virtual machine",
+ "name": "serviceofferingname",
+ "type": "string"
+ },
+ {
+ "description": "the group name of the virtual machine",
+ "name": "group",
+ "type": "string"
+ },
+ {
+ "description": "the number of cpu this virtual machine is running with",
+ "name": "cpunumber",
+ "type": "integer"
+ },
+ {
+ "description": "OS name of the vm",
+ "name": "osdisplayname",
+ "type": "string"
+ },
+ {
+ "description": "the target memory in vm",
+ "name": "memorytargetkbs",
+ "type": "long"
+ },
+ {
+ "description": "the project id of the vm",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the backup offering of the virtual machine",
+ "name": "backupofferingname",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the ISO attached to the virtual machine",
+ "name": "isoid",
+ "type": "string"
+ },
+ {
+ "description": "OS type id of the vm",
+ "name": "ostypeid",
+ "type": "string"
+ },
+ {
+ "description": "the 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": "the group ID of the virtual machine",
+ "name": "groupid",
+ "type": "string"
+ },
+ {
+ "description": "list of security groups associated with the virtual machine",
+ "name": "securitygroup",
+ "response": [
+ {
+ "description": "the list of resource tags associated with the rule",
+ "name": "tags",
+ "response": [
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "the 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": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the domain name of the security group",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the security group",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the account owning the security group",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the list of virtualmachine ids associated with this securitygroup",
+ "name": "virtualmachineids",
+ "type": "set"
+ },
+ {
+ "description": "the name of the security group",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the group",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID of the security group",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the 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 list of resource tags associated with the rule",
+ "name": "tags",
+ "response": [
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "the 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"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the starting IP of the security group rule",
+ "name": "startport",
+ "type": "integer"
+ },
+ {
+ "description": "the id of the security group rule",
+ "name": "ruleid",
+ "type": "string"
+ },
+ {
+ "description": "the ending IP of the security group rule ",
+ "name": "endport",
+ "type": "integer"
+ },
+ {
+ "description": "the code for the ICMP message response",
+ "name": "icmpcode",
+ "type": "integer"
+ },
+ {
+ "description": "account owning the security group rule",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the protocol of the security group rule",
+ "name": "protocol",
+ "type": "string"
+ },
+ {
+ "description": "security group name",
+ "name": "securitygroupname",
+ "type": "string"
+ },
+ {
+ "description": "the CIDR notation for the base IP address of the security group rule",
+ "name": "cidr",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the 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 list of ingress rules associated with the security group",
+ "name": "ingressrule",
+ "response": [
+ {
+ "description": "the type of the ICMP message response",
+ "name": "icmptype",
+ "type": "integer"
+ },
+ {
+ "description": "security group name",
+ "name": "securitygroupname",
+ "type": "string"
+ },
+ {
+ "description": "the ending IP of the security group rule ",
+ "name": "endport",
+ "type": "integer"
+ },
+ {
+ "description": "the code for the ICMP message response",
+ "name": "icmpcode",
+ "type": "integer"
+ },
+ {
+ "description": "the CIDR notation for the base IP address of the security group rule",
+ "name": "cidr",
+ "type": "string"
+ },
+ {
+ "description": "the list of resource tags associated with the rule",
+ "name": "tags",
+ "response": [
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "account owning the security group rule",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the protocol of the security group rule",
+ "name": "protocol",
+ "type": "string"
+ },
+ {
+ "description": "the starting IP of the security group rule",
+ "name": "startport",
+ "type": "integer"
+ },
+ {
+ "description": "the id of the security group rule",
+ "name": "ruleid",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "Guest vm Boot Type",
+ "name": "boottype",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the service offering of the virtual machine",
+ "name": "serviceofferingid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the availability zone for the virtual machine",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
"description": "the list of nics associated with vm",
"name": "nic",
"response": [
{
- "description": "the cidr of IPv6 network",
- "name": "ip6cidr",
+ "description": "the ip address of the nic",
+ "name": "ipaddress",
"type": "string"
},
{
- "description": "the name of the corresponding network",
- "name": "networkname",
+ "description": "Type of adapter if available",
+ "name": "adaptertype",
"type": "string"
},
{
@@ -116085,11 +118492,56 @@
"type": "string"
},
{
+ "description": "the type of the nic",
+ "name": "type",
+ "type": "string"
+ },
+ {
+ "description": "the traffic type of the nic",
+ "name": "traffictype",
+ "type": "string"
+ },
+ {
"description": "the isolated private VLAN type if available",
"name": "isolatedpvlantype",
"type": "string"
},
{
+ "description": "the isolated private VLAN if available",
+ "name": "isolatedpvlan",
+ "type": "integer"
+ },
+ {
+ "description": "the broadcast uri of the nic",
+ "name": "broadcasturi",
+ "type": "string"
+ },
+ {
+ "description": "true if nic is default, false otherwise",
+ "name": "macaddress",
+ "type": "string"
+ },
+ {
+ "description": "the cidr of IPv6 network",
+ "name": "ip6cidr",
+ "type": "string"
+ },
+ {
+ "description": "the IPv6 address of network",
+ "name": "ip6address",
+ "type": "string"
+ },
+ {
+ "description": "Id of the vm to which the nic belongs",
+ "name": "virtualmachineid",
+ "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"
@@ -116100,23 +118552,13 @@
"type": "string"
},
{
- "description": "ID of the VLAN/VNI if available",
- "name": "vlanid",
- "type": "integer"
- },
- {
- "description": "the ID of the nic",
- "name": "id",
+ "description": "the gateway of the nic",
+ "name": "gateway",
"type": "string"
},
{
- "description": "the traffic type of the nic",
- "name": "traffictype",
- "type": "string"
- },
- {
- "description": "the IPv6 address of network",
- "name": "ip6address",
+ "description": "the name of the corresponding network",
+ "name": "networkname",
"type": "string"
},
{
@@ -116125,38 +118567,8 @@
"type": "list"
},
{
- "description": "the broadcast uri of the nic",
- "name": "broadcasturi",
- "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 Secondary ipv4 addr of nic",
- "name": "secondaryip",
- "type": "list"
- },
- {
- "description": "device id for the network when plugged into the virtual machine",
- "name": "deviceid",
- "type": "string"
- },
- {
- "description": "the ip address of the nic",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "description": "the isolation uri of the nic",
- "name": "isolationuri",
+ "description": "the ID of the nic",
+ "name": "id",
"type": "string"
},
{
@@ -116170,13 +118582,18 @@
"type": "list"
},
{
- "description": "the type of the nic",
- "name": "type",
+ "description": "the Secondary ipv4 addr of nic",
+ "name": "secondaryip",
+ "type": "list"
+ },
+ {
+ "description": "the gateway of IPv6 network",
+ "name": "ip6gateway",
"type": "string"
},
{
- "description": "true if nic is default, false otherwise",
- "name": "macaddress",
+ "description": "device id for the network when plugged into the virtual machine",
+ "name": "deviceid",
"type": "string"
},
{
@@ -116185,77 +118602,66 @@
"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": "Type of adapter if available",
- "name": "adaptertype",
- "type": "string"
+ "description": "ID of the VLAN/VNI if available",
+ "name": "vlanid",
+ "type": "integer"
}
],
"type": "set"
},
{
- "description": "the group ID of the virtual machine",
- "name": "groupid",
- "type": "string"
- },
- {
- "description": "ssh key-pair",
- "name": "keypair",
- "type": "string"
- },
- {},
- {
- "description": "the vgpu type used by the virtual machine",
- "name": "vgpu",
- "type": "string"
- },
- {
- "description": "the name of the disk offering of the virtual machine",
- "name": "diskofferingname",
- "type": "string"
- },
- {
- "description": "the ID of the host for the virtual machine",
- "name": "hostid",
- "type": "string"
- },
- {
- "description": "user generated name. The name of the virtual machine is returned if no displayname exists.",
- "name": "displayname",
- "type": "string"
- },
- {
"description": "an alternate display text of the ISO attached to the virtual machine",
"name": "isodisplaytext",
"type": "string"
},
{
- "description": "instance name of the user vm; this parameter is returned to the ROOT admin only",
- "name": "instancename",
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the amount of the vm's CPU currently used",
+ "name": "cpuused",
"type": "string"
},
{
- "description": "the incoming network traffic on the vm",
- "name": "networkkbsread",
+ "description": "the write (bytes) of disk on the vm",
+ "name": "diskkbswrite",
"type": "long"
},
{
- "description": "the hypervisor on which the template runs",
- "name": "hypervisor",
+ "description": "the ID of the virtual machine",
+ "name": "id",
"type": "string"
},
{
- "description": " an alternate display text of the template for the virtual machine",
- "name": "templatedisplaytext",
+ "description": "Os type ID of the virtual machine",
+ "name": "guestosid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the virtual machine",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.",
+ "name": "isdynamicallyscalable",
+ "type": "boolean"
+ },
+ {
+ "description": "State of the Service from LB rule",
+ "name": "servicestate",
+ "type": "string"
+ },
+ {
+ "description": "the total number of network traffic bytes sent",
+ "name": "sentbytes",
+ "type": "long"
+ },
+ {
+ "description": "the project name of the vm",
+ "name": "project",
"type": "string"
},
{
@@ -116263,8 +118669,28 @@
"name": "tags",
"response": [
{
- "description": "tag key name",
- "name": "key",
+ "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"
},
{
@@ -116283,738 +118709,82 @@
"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": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
"description": "tag value",
"name": "value",
"type": "string"
},
{
- "description": "resource type",
- "name": "resourcetype",
+ "description": "tag key name",
+ "name": "key",
"type": "string"
}
],
"type": "set"
},
{
- "description": "the total number of network traffic bytes sent",
- "name": "sentbytes",
- "type": "long"
- },
- {
- "description": "true if the password rest feature is enabled, false otherwise",
- "name": "passwordenabled",
- "type": "boolean"
- },
- {
- "description": "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": "the read (io) of disk on the vm",
- "name": "diskioread",
- "type": "long"
- },
- {
- "description": "the internal memory that's free in vm or zero if it can not be calculated",
- "name": "memoryintfreekbs",
- "type": "long"
- },
- {
- "description": "the name of the ISO attached to the virtual machine",
- "name": "isoname",
- "type": "string"
- },
- {
- "description": "Vm details in key/value pairs.",
- "name": "details",
- "type": "map"
- },
- {
- "description": "the name of the service offering of the virtual machine",
- "name": "serviceofferingname",
- "type": "string"
- },
- {
- "description": "the read (bytes) of disk on the vm",
- "name": "diskkbsread",
- "type": "long"
- },
- {
- "description": "the date when this virtual machine was updated last time",
- "name": "lastupdated",
- "type": "date"
- },
- {
- "description": "OS type id of the vm",
- "name": "ostypeid",
- "type": "string"
- },
- {
- "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.",
- "name": "isdynamicallyscalable",
- "type": "boolean"
- },
- {
- "description": "the pool type of the virtual machine",
- "name": "pooltype",
- "type": "string"
- },
- {
- "description": "the project id of the vm",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the ID of the virtual machine",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the project name of the vm",
- "name": "project",
- "type": "string"
- },
- {
- "description": "list of security groups associated with the virtual machine",
- "name": "securitygroup",
- "response": [
- {
- "description": "the list of ingress rules associated with the security group",
- "name": "ingressrule",
- "response": [
- {
- "description": "the code for the ICMP message response",
- "name": "icmpcode",
- "type": "integer"
- },
- {
- "description": "the ending IP of the security group rule ",
- "name": "endport",
- "type": "integer"
- },
- {
- "description": "the 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 starting IP of the security group rule",
- "name": "startport",
- "type": "integer"
- },
- {
- "description": "account owning the security group rule",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the list of resource tags associated with the rule",
- "name": "tags",
- "response": [
- {
- "description": "the 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": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the id of the security group rule",
- "name": "ruleid",
- "type": "string"
- },
- {
- "description": "security group name",
- "name": "securitygroupname",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the domain name of the security group",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the list of resource tags associated with the rule",
- "name": "tags",
- "response": [
- {
- "description": "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": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "the project 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": "the account associated with the tag",
- "name": "account",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the ID of the security group",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the project name of the group",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the 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 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": "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": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the starting IP of the security group rule",
- "name": "startport",
- "type": "integer"
- },
- {
- "description": "the code for the ICMP message response",
- "name": "icmpcode",
- "type": "integer"
- },
- {
- "description": "security group name",
- "name": "securitygroupname",
- "type": "string"
- },
- {
- "description": "the ending IP of the security group rule ",
- "name": "endport",
- "type": "integer"
- },
- {
- "description": "the protocol of the security group rule",
- "name": "protocol",
- "type": "string"
- },
- {
- "description": "account owning the security group rule",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the 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"
- }
- ],
- "type": "set"
- },
- {
- "description": "the account owning the security group",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the project id of the group",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the list of virtualmachine ids associated with this securitygroup",
- "name": "virtualmachineids",
- "type": "set"
- },
- {
- "description": "the number of virtualmachines associated with this securitygroup",
- "name": "virtualmachinecount",
- "type": "integer"
- },
- {
- "description": "the name of the security group",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the description of the security group",
- "name": "description",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "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": "publicip",
- "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 name of the virtual machine",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the target memory in vm",
- "name": "memorytargetkbs",
- "type": "long"
- },
- {
- "description": "device ID of the root volume",
- "name": "rootdeviceid",
- "type": "long"
- },
- {
- "description": "device type of the root volume",
- "name": "rootdevicetype",
- "type": "string"
- },
- {
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "the amount of the vm's CPU currently used",
- "name": "cpuused",
- "type": "string"
- },
- {
- "description": "Os type ID of the virtual machine",
- "name": "guestosid",
- "type": "string"
- },
- {
- "description": "the account associated with the virtual machine",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the outgoing network traffic on the host",
- "name": "networkkbswrite",
- "type": "long"
- },
- {
- "description": "the virtual network for the service offering",
- "name": "forvirtualnetwork",
- "type": "boolean"
- },
- {
- "description": "the ID of the backup offering of the virtual machine",
- "name": "backupofferingid",
- "type": "string"
- },
- {
- "description": "Guest vm Boot Mode",
- "name": "bootmode",
- "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 name of the affinity group",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the type of the affinity group",
- "name": "type",
- "type": "string"
- },
- {
- "description": "the project ID of the affinity group",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the project name of the affinity group",
- "name": "project",
- "type": "string"
- },
- {
- "description": "virtual machine IDs associated with this affinity group",
- "name": "virtualmachineIds",
- "type": "list"
- },
- {
- "description": "the description of the affinity group",
- "name": "description",
- "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 ID of the affinity group",
- "name": "id",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the name of the domain in which the virtual machine exists",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the write (io) of disk on the vm",
- "name": "diskiowrite",
- "type": "long"
- },
- {
- "description": "Guest vm Boot Type",
- "name": "boottype",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the number of cpu this virtual machine is running with",
- "name": "cpunumber",
- "type": "integer"
- },
- {
- "description": "OS name of the vm",
- "name": "osdisplayname",
- "type": "string"
- },
- {
- "description": "true if high-availability is enabled, false otherwise",
- "name": "haenable",
- "type": "boolean"
- },
- {
- "description": "the name of the template for the virtual machine",
- "name": "templatename",
- "type": "string"
- },
- {
- "description": "the memory allocated for the virtual machine",
- "name": "memory",
- "type": "integer"
- },
- {
- "description": "the name of the backup offering of the virtual machine",
- "name": "backupofferingname",
- "type": "string"
- },
- {
- "description": "the state of the virtual machine",
- "name": "state",
- "type": "string"
- },
- {
- "description": "the user's name who deployed the virtual machine",
- "name": "username",
- "type": "string"
- },
- {
- "description": "the name of the host for the virtual machine",
- "name": "hostname",
- "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 created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the ID of the disk offering of the virtual machine",
- "name": "diskofferingid",
+ "description": "device type of the root volume",
+ "name": "rootdevicetype",
"type": "string"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the account associated with the virtual machine",
+ "name": "account",
"type": "string"
},
- {},
{
- "description": "the memory used by the vm",
- "name": "memorykbs",
+ "description": "the write (io) of disk on the vm",
+ "name": "diskiowrite",
"type": "long"
},
{
- "description": "the write (bytes) of disk on the vm",
- "name": "diskkbswrite",
- "type": "long"
- },
- {
- "description": "the ID of the ISO attached to the virtual machine",
- "name": "isoid",
- "type": "string"
- },
- {
- "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.",
- "name": "templateid",
- "type": "string"
- },
- {
- "description": "an optional field whether to the display the 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 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 speed of each cpu",
- "name": "cpuspeed",
- "type": "integer"
- },
- {
- "description": "the name of the availability zone for the virtual machine",
- "name": "zonename",
- "type": "string"
- },
- {
"description": "the ID of the domain in which the virtual machine exists",
"name": "domainid",
"type": "string"
},
{
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the incoming network traffic on the vm",
+ "name": "networkkbsread",
+ "type": "long"
+ },
+ {
+ "description": "the outgoing network traffic on the host",
+ "name": "networkkbswrite",
+ "type": "long"
+ },
+ {
"description": "the ID of the availablility zone for the virtual machine",
"name": "zoneid",
"type": "string"
+ },
+ {
+ "description": "the name of the template for the virtual machine",
+ "name": "templatename",
+ "type": "string"
+ },
+ {
+ "description": "the virtual network for the service offering",
+ "name": "forvirtualnetwork",
+ "type": "boolean"
+ },
+ {
+ "description": "the pool type of the virtual machine",
+ "name": "pooltype",
+ "type": "string"
}
]
},
@@ -117024,12 +118794,12 @@
"name": "createNetworkACLList",
"params": [
{
- "description": "an optional field, whether to the display the list to the end user or not",
+ "description": "ID of the VPC associated with this network ACL list",
"length": 255,
- "name": "fordisplay",
- "required": false,
- "since": "4.4",
- "type": "boolean"
+ "name": "vpcid",
+ "related": "createVPC,listVPCs,updateVPC",
+ "required": true,
+ "type": "uuid"
},
{
"description": "Description of the network ACL list",
@@ -117039,24 +118809,29 @@
"type": "string"
},
{
- "description": "ID of the VPC associated with this network ACL list",
- "length": 255,
- "name": "vpcid",
- "related": "createVPC,listVPCs,updateVPC",
- "required": true,
- "type": "uuid"
- },
- {
"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,
+ "name": "fordisplay",
+ "required": false,
+ "since": "4.4",
+ "type": "boolean"
}
],
"related": "",
"response": [
{
+ "description": "Description of the ACL",
+ "name": "description",
+ "type": "string"
+ },
+ {
"description": "Id of the VPC this ACL is associated with",
"name": "vpcid",
"type": "string"
@@ -117067,14 +118842,9 @@
"type": "string"
},
{
- "description": "Description of the ACL",
- "name": "description",
- "type": "string"
- },
- {
- "description": "the Name of the ACL",
- "name": "name",
- "type": "string"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
{},
{
@@ -117083,9 +118853,9 @@
"type": "boolean"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "the Name of the ACL",
+ "name": "name",
+ "type": "string"
},
{},
{
@@ -117096,5 +118866,5 @@
]
}
],
- "count": 623
+ "count": 635
}
